JSDoc
コメント形式で書ける
documentを生成するtoolもある
web標準のESModule形式で書かれているTS/JSファイルならdoc.deno.landで自動生成できる
型チェックをさせるには少し工夫が必要
Node.jsは知らん
compilerOptions.checkJsでいけるんじゃないかな
記法 (一部)
@type{}https://www.typescriptlang.org/ja/docs/handbook/jsdoc-supported-types.html#typedefcallbackおよびparam
$ /** @type {string} */変数の型を指定する
$ const test = /** @type {string} */ (new Date().getTime());@typedef{}https://www.typescriptlang.org/ja/docs/handbook/jsdoc-supported-types.html#typedefcallbackおよびparam
js/**
* @typedef {object} Path scrapboxのリンクを表す
* @prop {string} project project name
* @prop {stirng} title page title
* @prop {string=} id line id
*/ object は Object でもいいoptional引数の記法は↓のどれでもいい
$ @prop {string=} id line id$ @prop [string] id line iddefault引数は
[] 記法でのみ書ける$ @prop [string="takker"] project project namedeclareに相当する型推論だけは書けないので注意
裏を返すと、それ以外の型機能しか使わないなら、JavaScript onlyで書ける
References
TypeScriptで扱える記法
Denoもこれに準拠していると思われる
Deno環境での書き方
#2024-08-02 13:18:52
#2024-04-26 07:01:46
#2022-05-20 18:10:30
#2021-07-24 17:20:05