2016-10-20 10 views
-1

多くのjavascriptファイルで言及されている@記号に気づき、この文字の意味を理解できませんでした。たとえば、
@記号はjavascriptの中の何かを意味しますか?

/** 
    * Calls the specified callback function for all the elements in an array. The return value of 
    * the callback function is the accumulated result, and is provided as an argument in the next 
    * call to the callback function. 
    * @param callbackfn A function that accepts up to four arguments. The reduce method calls the 
    * callbackfn function one time for each element in the array. 
    * @param initialValue If initialValue is specified, it is used as the initial value to start 
    * the accumulation. The first call to the callbackfn function provides this value as an argument 
    * instead of an array value. 
*/ 

ここで@paramは何かを意味しますか?
P.S. - 上記はcallbackfnとinitialValueをパラメータとする関数の説明です。

+0

docの生成目的のために - http://usejsdoc.org/でexapmpleを見てください –

+0

可能な重複:http://stackoverflow.com/questions/14143123/does-the-symbol- javascript-coffeescript-or-jquery – Tom

答えて

1

このコメントはJSDocです。 @param callbackfnは、「次に続くものは引数callbackfnの記述です」を意味します。

あなたのIDEはそのフォーマットを解析できるかもしれませんし、use jsdocからドキュメントを生成することもできます。

+0

定義タイプスクリプトファイルでこのJSDocを解析する方法はありますか? –

0

文書化の目的のみです。

@paramは、あなたの関数がexempleのために取るパラメータを示します。 @authorのように、もっと多くのものがあります。

0

これはjavadocスタイルのコメントです。 javadocのドキュメントを参照してください

関連する問題