16

それらの関数またはプロパティに関連付けられた適切にフォーマットされたコメント ブロックがない場合でも、JavaScript 関数およびプロパティのドキュメントを生成するツールを探しています (Doxygen のように)。

このJSDoc と他のドキュメント作成ツールとの比較では、JSDoc はコメント ブロック (前述の Doxygen など) がなくても、ソース コードを解析してドキュメントを生成できることが示されています。彼らは、他のすべてのツールはコメント ブロックを解析するだけだと言っています。

この指示に従って、npm (ノード上) から JSDoc 3.3.0-alpha4 をインストールし、プロジェクトのドキュメントを生成しようとしています。私が見る限り、JSDoc は、関連する JSDoc フラグを含む適切なコメントを持たない関数またはプロパティのドキュメントを生成しません。

JSDoc が何度も繰り返されてきたことは知っていますが、この機能は削除されたのでしょうか、それとも適切なスイッチを使用していないのでしょうか? コマンド ライン オプションを確認しようとしましたが、そのためのスイッチが見つかりませんでした。私は単に次のように使用しています：

./node_modules/.bin/jsdoc -r -l my_project --destination doc/

smartcommentsなど、コードにドキュメント ブロックを自動的に追加できるツールが他にもあることは知っていますが、それはまさに私が探しているものではありません。誰かがそれに光を当てることができますか？

4

1 に答える 1

0

プロジェクトにYuidocを使用しました。コードを読み取らず、@class、@module、@method などの Yuidoc タグのみを読み取ります。次のようにコメント ブロックで囲みます: /** */ Node cmd を含む javascript フォルダーとコマンドの実行:

yuidoc .

使い方がわからないと、最初は少し難しいです。

たとえば、次のような yuidoc タグがあるとします。

/**
 * @class Claculator
 * @method claculate
 * @param {Number} a
 * @param {Number} b
 * @return {Number}
 */
function calculate(a, b) {

}

/**
 * @class Graphics
 * @method drawGUI
 * @param {Number} x
 * @param {Number} y
 * @param {Number} z
 * @return {Number}
 */
function drawGUI(x, y, z) {

}

@class タグに続くすべてのメソッド/プロパティは、生成後に Calculator クラスの一部になります。したがって、calculate(a, b) の後に drawGUI() というメソッドがあり、それが Graphics などの他のクラスに属している必要がある場合は、上記の例のように別の @class タグにも注意する必要があります。

注: 私の見解では、コメント ブロックを記述すると、開発中のコードの品質が向上し、問題が発生する前に発見するのにも役立ちます。

于 2015-02-17T17:01:16.517 に答える