JSDoc の導入と使用仕様 JsDoc_javascript スキルの使用の概要

JsDoc Toolkit は少し前にバージョン 2.3.2 をリリースしましたが、これは主に以前のバージョンを修正したものです。
Ant を使用する必要がある場合、JsDoc には Ant プラグインもあります: JsDoc Toolkit Ant Task
JsDoc Toolkit2.3.2 をダウンロード: http://jsdoc-toolkit.googlecode .com/files/jsdoc_toolkit-2.3.2.zip
コマンド名の説明
@param @argument 関数のパラメータを記述するパラメータ名と説明を指定します

@returns 関数の説明
@author の戻り値は、コードの作成者を示します。
@deprecated は、関数が非推奨であり、コードの将来のバージョンで完全に削除されることを示します。このコードの使用を避けるには
@see 指定されたクラスの説明を指す HTML リンクを作成します
@version リリース バージョンを指定します
@requires このクラスに必要な指定されたクラスを指す HTML リンクを作成します
@throws @Exception 関数がスローする可能性のある例外のタイプを記述します。
{@link} 指定されたクラスを指す HTML リンクを作成します。 @see と似ていますが、コメントテキストに {@link} を埋め込むことができます。
@fileoverview これは特別なタグです。このタグがファイルの最初のドキュメント ブロックで使用される場合、ドキュメント ブロックの残りの部分がファイルの概要を提供するために使用されることを指定します。
@class は、ファイルのドキュメントで使用されるクラスに関する情報を提供します。コンストラクター
@constructor は、関数が特定のクラスのコンストラクターであることを明確にします。
@type は、関数の戻り値の型を指定します。
@extends は、あるクラスが別のクラスから派生することを示します。通常、JSDoc はこの情報を単独で検出できますが、場合によっては、タグ
@private を使用して、クラスまたは関数がプライベートであることを示す必要があります。 JSDoc
@final の実行時に、値が定数値であることを示す --private コマンド ライン オプションが指定されない限り、プライベート クラスと関数は HTML ドキュメントに表示されません。 JavaScript は値が定数であることを真に保証できないことに注意してください
@ignore JSDoc はこのタグを持つ関数を無視します

JsDoc: JavaScript プログラム ソースからクラス、メソッド、およびメンバーを抽出する JS ドキュメント生成ツールですコード 注釈情報は、ソース コードと一致する API ヘルプ ドキュメントを形成します。
Java オープン ソース プロジェクト http://www.jsdoctoolkit.org/。これは強力な JavaScript ドキュメント生成ツールです。
使い方を終わりにしましょう。
ツールライブラリをダウンロードします。
ここでは、現在の最新バージョンである jsdoc_toolkit-2.1.0.zip を使用しています。
このファイルを解凍してみましょう。中に README.txt ファイルが入っています。
詳しい使用方法はこちらです。 【ここで紹介できるようです。もちろん、読み続けていただくこともできます]
ここでは、コマンド ラインを使用して JavaScript ドキュメントを作成する必要があります。
java -jar jsrun.jar app/run.js -a -e=GB18030 -t=templates/jsdoc test/*.js
もちろん、コマンドラインを使用する方が面倒だと思われる場合は、自分で作成することもできます。 .bat ファイル
上記の内容をファイルにコピーして実行します。
パラメータについて簡単に説明します。
-a はすべてのメソッドを表します。
-e は、対応するファイルのエンコーディング ルートを表します。デフォルトは utf-8 です。
-t ドキュメントを表します。本番ドキュメントのスタイル テンプレート
ここでの test/*.js は、テスト ディレクトリ内のすべての JavaScript ファイルを表します
実行後、ドキュメントの結果はデフォルトで /out/jsdoc ディレクトリに出力されます。もちろん、このディレクトリも定義できます
特定のパラメータは、
java -jar jsrun.jar app/run.js --help
を使用して表示できます。
結果は次のようになります:

コードをコピーします コードは次のようになります:

オプション:
- a または --allfunctions
文書化されていない関数も含めて、すべての関数を含めます。
-d= または--directory=< PATH>
このディレクトリに出力します (デフォルトは "out")。
-D="myVar:My value" または --define="myVar:My value"
JSDOC.opt.D.myVar として変数を定義します。
-e=
このエンコーディングを使用します。 >-E="REGEX " または --exclude="REGEX"
指定された正規表現に基づいてファイルを除外します。
-h または --help
このメッセージを表示して終了します。 n または --nocode
すべてのコードを無視し、@name タグを持つコメントのみを文書化します。
-o= または --out=
ログ メッセージをファイルに出力します。
-p または --private
プライベート、アンダースコア付き、および内部シンボルとしてタグ付けされたシンボルを含めます。
-q または --quiet
警告も含めてメッセージを出力しません。 🎜>

テスト対象の js ファイルを作成しましょう

myjs.js をマークする簡単な方法

コードをコピーします

コードは次のとおりです:

/**
* @fileOverview Simple method annotation example
* @author llying
* @version 0.1
*/

/**
* @description addition operation
* @param {Num} num1 addend
* @param {Num} num2 summand
* @return {Num} result result
*/
function add(num1,num2){
return num1 num2;
}
/**
* @description subtraction operation
* @param {Num} num1 minuend
* @param {Num} num2 minuend
* @return {Num} result result
*/
function minus(num1,num2){
return num1 - num2;
}

Class method annotation
myjs2.js

Copy code The code is as follows:

/**
* @fileOverview Simple class object annotation example
* @author llying
* @version 0.1
*/
/**
* @author llying
* @constructor Person
* @description a Person class
* @see The llying.
* @example new Parent("张三",15);
* @since version 0.1
* @param {String} username name
* @param {Num} age age
*/
function Person(username,age)
{
/**
* @description {Sting} Name
* @field
*/
this.username = username;
/**
* @description {Num} Age
* @field
*/
this.age = age
/**
* @description Pop-up say content
* @param {String} content content
*/
this.say = function(content)
{
alert(this.username " say : " content);
}
/**
* @description Returns an object in json format
* @return {String} json format
* @see Person#say
*/
this.getJson = function(){
return "{name:" this.username ",age" this.age " }";
}
}

Now we can run java -jar jsrun.jar app/run.js -a -e=GB18030 -t=templates/jsdoc test/* .js

Now our js document is generated. We don’t need to envy JavaDoc anymore.

We just listed the commonly used tags. For more information, you can log in to the official website to view
http://code.google.com/p/jsdoc-toolkit/wiki/TagReference