JavaScriptコードにコメントするツールはありますか？

Question

javascriptのコメント用ツールは、ghost docのようにC＃にあるので、そこにありますか？

/// <summary> 
/// Method to calculate distance between two points 
/// </summary> 
/// <param name="pointA">First point</param> 
/// <param name="pointB">Second point</param> 
function calculatePointDistance(pointA, pointB) 
{ 
    ... 
} 

上記のようなコメントを自動的に追加するツールがあります。 C＃コードゴーストドキュメントのよう はなかった：

/// <summary> 
/// Method to calculate distance between two points 
/// </summary> 
/// <param name="pointA">First point</param> 
/// <param name="pointB">Second point</param> 
private void calculatePointDistance(pointA, pointB) 
{ 
    ..... 
} 

私はクライアント側で同様の操作を行いたい、javascriptを

Answer 1

はい（しかし、よりJavadocのような） - look at JSDoc 基本的には、中のJavadocのような特殊な構文を使用しますあなたのコメントパーサ次の例では、その後のような@paramあなたは

/** 
* Shape is an abstract base class. It is defined simply 
* to have something to inherit from for geometric 
* subclasses 
* @constructor 
*/ 
function Shape(color){ 
    this.color = color; 
} 

Answer 2

私は個人的にそれを使用していないために格好良いHTML出力を生成しますが、jsdoc-toolkitあなたが後にしている何のようです。

Answer 3

短い答えはいいえ、ドキュメントを自動化するものはありません。あなたが手に入れるのは、文書をhtmlページに作ることを可能にするjsdoc-toolkitのようなものを手動で追加することです。

は（それはしかし、関数内で気づく）

function example(var myParameter){ 
    /// <summary>This is an example function</summary> 
    /// <param name="myParameter" type="String">All your string are belong to us.</param> 
    /// <returns type="Boolean" /> 

    return !!myParameter; 
} 

あなたはまた、JavaScriptファイルのためのスニペットを作成することができ、このようになります。これは、同様のjavascriptのためのjavascriptのためのインテリセンスのドキュメントがあります。私はちょうどいくつかのスニペットを作成して一般的なドキュメント（あなたが好きな任意のタイプ）を記入し、スニペットを入力するだけでドキュメントのほとんどがあなたのために記入されます。

Answer 4

私はJavaScriptのために使用していませんが、少なくともある程度はJavaScriptを文書化するために使用します。Doxygen has a filter Doxygenでもサポートされている他の言語を使用している場合は、特に参考になるかもしれません。

JSUnitはドキュメントとしてDoxygenを使用しているようです。

Answer 5

SandcastleもJavaScriptをサポートしているようです（http://blogs.msdn.com/sandcastle/archive/2007/06/28/scriptdoc-1-0-for-extractiong-javascript-code-comments-is-now-available-at-codeplex.aspxを参照）。私はNDocプロジェクトがトーストなのでC＃のために使用しますが、まだJavaScriptのためにそれを試していません。私は上記のJSDocを使用していました。

Answer 6

誰がそうでないとJavaScriptをサポートする予定がないことをチームメンバーからの直接の答えがありますGhostdocのブログでDocStubsJS