javascript - jsdoc の有効なパラメータ タイプ

Question

jsdoc の param タグの有効なタイプのリストはありますか? 例えば、

@param {type} myParam Some parameter description

numberやが有効であることはわかっていStringますが、数値が整数であることを文書化したい場合はどうすればよいでしょうか。int有効ですか？

グーグルで調べてみましたが、完全なリストが見つからないようです。

Answer 1

私が使用した JS ドキュメンテーション ツールは、とにかくコメントを文字列にトークン化するだけで、{type} セクションに必要なものを何でも入れることができます。

{number} や {string} のように JavaScript の型を使い続けることもできますし、指定したい場合は {integer} にすることもできますが、次のようなものをお勧めします。

@param {number} myParam must be an integer

乾杯