62

私は Atlas に慣れており、(私が知っていることから) 推奨される方法は、次のような XML コメントを使用することです。

/// <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) { ... }

最近、他のサードパーティの JavaScript ライブラリを調べていると、次のような構文が表示されます。

/*
 * some comment here
 * another comment here
 * ...
 */
 function blahblah() { ... }

おまけとして、「優先」コメント スタイルを読み取ることができる JavaScript 用の API ジェネレーターはありますか?

4

5 に答える 5

91

JSDocがあります

/**
 * 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;
}
于 2008-09-24T13:26:00.117 に答える
21

シンプルであるほど良い、コメントは良いです、それらを使用してください:)

var something = 10; // My comment

/*
Lorem ipsum dolor sit amet, consectetur adipisicing elit,
sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco
nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor
in reprehenderit in voluptate velit esse cillum dolore eu
fugiat nulla pariatur.
*/

function bigThing() {
    // ...
}

しかし、自動生成されたドキュメントの場合...

/**
 * Adds two numbers.
 * @param {number} num1 The first number to add.
 * @param {number} num2 The second number to add.
 * @return {number} The result of adding num1 and num2.
 */
function bigThing() {
    // ...
}
于 2013-01-19T22:38:19.060 に答える
8

YahooはYUIDocを提供しています。

これは十分に文書化されており、Yahooによってサポートされており、Node.jsアプリです。

また、同じ構文を多く使用しているため、一方から他方に移動するために多くの変更を加える必要はありません。

于 2008-12-18T20:40:35.500 に答える
3

以下を Visual Studio 08 の JavaScript ファイルに貼り付けて、試してみてください。

var Namespace = {};
    Namespace.AnotherNamespace = {};

Namespace.AnotherNamespace.annoyingAlert = function(_message)
{
    /// <param name="_message">The message you want alerted two times</param>
    /// <summary>This is really annoying!!</summary>

    alert(_message);
    alert(_message);
};

インテリセンス満載！

これに関する詳細情報 (大規模なライブラリで使用するための外部 javascript ファイルの参照方法を含む) は、 Scott Gu のブログで見つけることができます。

于 2008-09-24T14:43:27.590 に答える
3

最初の例でのトリプル コメントの使用は、実際には外部の XML ドキュメント ツールと (Visual Studio での) Intellisense サポートに使用されます。それはまだ有効なコメントですが、その特別な :) 実際のコメント 'operator' は // 唯一の制限は、1 行だけです。

2 番目の例では、C スタイルのブロック コメントを使用して、複数行または行の途中でコメントを付けることができます。

于 2008-09-24T13:24:41.010 に答える