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을 사용하여 함수의 매개변수를 나타내며, @param은 가장 일반적인 매개변수입니다. JSDoc에서 일반적으로 사용되는 주석 태그입니다. 매개변수 레이블은 매개변수의 매개변수 이름, 매개변수 유형 및 매개변수 설명 주석을 나타낼 수 있습니다. 아래와 같이:

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

@return 반환 값 주석

@return은 함수가 표시되지 않는 경우 함수의 반환 값을 나타냅니다. 지정된 반환 값을 작성하지 마십시오. 아래와 같이

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

@example 예제 주석

@example은 일반적으로 예제 코드를 나타내는 데 사용되며 일반적으로 예제의 코드입니다. 새 줄에서 시작됩니다. 다음과 같이 작성합니다.

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

Other common comments

@overview현재 코드 파일에 대한 설명입니다.

@copyright코드의 저작권 정보입니다.

@author [] 코드의 작성자 정보입니다.

@version 현재 코드의 버전입니다.

위 내용은 JSDoc이란 무엇입니까? JSDoc 주석 사양 소개의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!