⬜JSDocを書く (scrapbox-jp/types)
scrapbox-jp/typesのdocumentをJSDocで書く
現状
一部しか書いていない
書いてあるものも、何故かhelpに反映されない?
複数行でコメントを書かないとだめなのか?
この辺りも調べておきたい
doc.deno.landにはちゃんと反映されていたから問題なさそう
https://doc.deno.land/https/raw.githubusercontent.com%2Fscrapbox-jp%2Ftypes%2F0.0.3%2Fscrapbox.d.ts
ただ、改行などが若干消えている
/deno-ja/doc.deno.landで使えるJSDoc記法
markdownでは空行を挟まないと改行とみなされないみたい
type aliasはJSDocを書いても反映されない模様
説明を付けたいものは、なるべくinferfaceで書いたほうがよさそう
user idとかをtype UserId = stringとかで別名で定義してもよさそう
こんな風にすれば、documentも統一できる
code:ts
/** the user id */
type UserId = string;
TypeScript.icon
Deno.icon