Was ist JSDoc? Einführung in die JSDoc-Annotationsspezifikationen

Der Inhalt dieses Artikels befasst sich mit der Frage: Was ist JSDoc? Die Einführung der JSDoc-Annotationsspezifikationen hat einen gewissen Referenzwert. Freunde in Not können sich darauf beziehen.

Was ist JSDoc

JSDoc ist ein Tool, das API-Dokumentation für JavaScript-Anwendungen oder -Module basierend auf Annotationsinformationen in JavaScript-Dateien generiert. Sie können JSDoc-Tags wie Namespace, Klasse, Methode, Methodenparameter usw. verwenden. Dies ermöglicht es Entwicklern, den Code einfach zu lesen und die durch den Code definierten Klassen sowie ihre Eigenschaften und Methoden zu beherrschen, wodurch die Wartungskosten gesenkt und die Entwicklungseffizienz verbessert werden.

JSDoc-Kommentarregeln

JSDoc-Kommentare sollten im Allgemeinen vor einer Methoden- oder Funktionsdeklaration platziert werden und müssen mit /** beginnen, um vom JSDoc erkannt zu werden Parser. Alle anderen Kommentare, die mit /* , /*** beginnen oder mit mehr als 3 Sternchen beginnen, werden vom JSDoc-Parser ignoriert. Wie unten gezeigt:

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

Der Kommentareffekt von JSDoc

Wenn wir einen Code wie diesen ohne Kommentare haben, scheint es, dass gewisse Kosten anfallen.

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

Wenn Sie JSDoc zum Kommentieren des Codes verwenden, wird die Lesbarkeit des Codes erheblich verbessert.

/**
* 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 Konstruktor-Deklarationsanmerkung

@constructor macht deutlich, dass eine Funktion ein Konstruktor einer bestimmten Klasse ist.

@param-Parameteranmerkung

Wir verwenden normalerweise @param, um die Parameter von Funktionen und Klassenmethoden darzustellen. @param ist das am häufigsten verwendete Annotations-Tag in JSDoc. Parameterbezeichnungen können den Parameternamen, den Parametertyp und Kommentare zur Parameterbeschreibung eines Parameters darstellen. Wie unten gezeigt:

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

@return Rückgabewertanmerkung

@return gibt den Rückgabewert einer Funktion an. Wenn die Funktion den angegebenen Rückgabewert nicht anzeigt, wird sie angezeigt muss nicht geschrieben werden. Wie unten gezeigt:

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

@example Beispielanmerkung

@example wird normalerweise verwendet, um Beispielcode anzugeben. Normalerweise wird der Beispielcode in eine separate Zeile geschrieben unten gezeigt:

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

Andere häufige Kommentare

@Übersichtsbeschreibung der aktuellen Codedatei.

@copyrightUrheberrechtliche Informationen zum Code.

@author [] Autoreninformationen des Codes.

@version Die Version des aktuellen Codes.

Das obige ist der detaillierte Inhalt vonWas ist JSDoc? Einführung in die JSDoc-Annotationsspezifikationen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!