2013-01-02 11 views
15

jsdocのparamタグに有効なタイプのリストがありますか?例えば、jsdoc有効なパラメータタイプ

@param {type} myParam Some parameter description 

は私がnumberStringのようなものが有効であることを知っているが、私は数が整数であることを文書化したい場合。 intは有効ですか?

私はいくつかのグーグルをやったことがありますが、私は完全なリストを見つけることはできません。

答えて

13

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

あなたは{番号}のように望んでいた場合は、JavaScriptの種類にこだわることができ、またはあなたが{整数}を行うことができます指定したい場合は...私はおそらくのようなものをお勧めします:

@param {Number} myParam must be an integer

歓声を

+3

私はツールが一般的に文字列をトークン化していることに気がついたので、それは本当に重要ではありません。私はちょうどいくつかの標準セットがあることを望んでいました。 javascriptタイプのシステムでは表現力が十分ではないようです(例:Numberはあまり具体的ではありません)。しかし、上に示したようなオプションがあります。 –

+2

{}の中に何かを入れることはできますが、どのような表記法を知っていいのでしょうか?本当にリストはありませんか? Prototypeオブジェクトを指定するための規約がありますか、それは@param {Object}である必要がありますか? – fraxture

+1

http://usejsdoc.org/tags-param.htmlのJSDocジェネレータ(https://github.com/jsdoc3/jsdoc)については、「パラメータタイプには組み込みJavaScriptタイプなどがあります。文字列またはオブジェクトとして、またはJSDocの名前パスをコード内の別のシンボルに追加します。コード内にシンボルがある場合、その定義にリンクが生成されます。しかし、組み込み型は文字列として表示されるため、実際の違いはありません。 '{string}'と '{String} 'の間にあります。また、たとえば、PhpStormはそれらを両方認識しますが、 '{Array} 'を受け入れる間に' {array}'について文句を言います。 –