JSDocとは何ですか? JSDoc アノテーション仕様の概要

この記事の内容は、JSDoc とは何ですか? JSDoc アノテーション仕様の紹介は、参考にしていただければ幸いです。

JSDoc とは

JSDoc は、JavaScript ファイル内のアノテーション情報に基づいて、JavaScript アプリケーションまたはモジュールの API ドキュメントを生成するツールです。名前空間、クラス、メソッド、メソッドパラメータなどの JSDoc タグを使用できます。これにより、開発者はコードを簡単に読み、コードで定義されたクラスとそのプロパティおよびメソッドを習得できるため、メンテナンス コストが削減され、開発効率が向上します。

JSDoc コメントのルール

JSDoc コメントは通常、メソッドまたは関数の宣言の前に配置する必要があり、JSDoc で認識されるように /** で始まる必要があります。パーサー。 /* 、 /*** で始まるコメント、または 3 つ以上のアスタリスクで始まるその他のコメントは、JSDoc パーサーによって無視されます。以下に示すように:

/*
**一段简单的 JSDoc 注释。
*/

JSDoc のコメント効果

コメントのないこのようなコードがある場合、一定のコストが発生しているように見えます。

functionBook(title, author){
      this.title=title;
      this.author=author;
}
Book.prototype={
      getTitle:function(){
        returnthis.title;   
      },
setPageNum:function(pageNum){
      this.pageNum=pageNum;   
}
};

JSDoc を使用してコードに注釈を付けると、コードの可読性が大幅に向上します。

/**
* Book类，代表一个书本.
* @constructor
* @param {string} title - 书本的标题.
* @param {string} author - 书本的作者.
*/
functionBook(title, author){
    this.title=title;
    this.author=author;
}
Book.prototype={
/**
* 获取书本的标题
* @returns {string|*} 返回当前的书本名称
*/
getTitle:function(){
    returnthis.title;   
},
/**
* 设置书本的页数
* @param pageNum {number} 页数
*/
setPageNum:function(pageNum){
    this.pageNum=pageNum;   
}
};

@constructor コンストラクター宣言アノテーション

@constructor は、関数が特定のクラスのコンストラクターであることを明確にします。

@param パラメータの注釈

通常、関数やクラス メソッドのパラメータを表すために @param を使用します。これは、JSDoc で最も一般的に使用されるコメント タグです。パラメータ ラベルは、パラメータのパラメータ名、パラメータ タイプ、パラメータ説明コメントを表すことができます。以下に示すように:

/**
* @param {String} wording 需要说的句子
*/
functionsay(wording){
    console.log(wording);
}

@return 戻り値コメント

@return は、関数が指定された戻り値を表示しない場合、関数の戻り値を示します。書く必要はありません。以下に示すように:

/*
* @return {Number} 返回值描述
*/

@example コメントの例

@example は通常、サンプル コードを表すために使用されます。通常、サンプルのコードは新しい行に記述されます。

/*
* @example
* multiply(3, 2);
*/

その他の一般的なコメント

@overview 現在のコード ファイルの説明。

@copyrightコードの著作権情報。

@author [] コードの作成者情報。

@version現在のコードのバージョン。

以上がJSDocとは何ですか? JSDoc アノテーション仕様の概要の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。