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와 유사하지만 댓글 텍스트
@fileoverview에 {@link}를 삽입할 수 있는 특수 태그입니다. 이 태그가 파일의 첫 번째 문서 블록에서 사용되는 경우 문서 블록의 나머지 부분이 파일 개요를 제공하는 데 사용됨을 지정합니다.
@class는 문서에 사용되는 클래스에 대한 정보를 제공합니다. constructor
@constructor는 함수가 특정 클래스의 생성자임을 분명히 합니다.
@type은 함수의 반환 유형을 지정합니다.
@extends는 한 클래스가 다른 클래스에서 파생됨을 나타냅니다. JSDoc은 일반적으로 이 정보를 자체적으로 감지할 수 있지만 어떤 경우에는 클래스나 함수가 비공개임을 나타내기 위해
@private 태그를 사용해야 합니다. JSDoc
@final을 실행할 때 --private 명령줄 옵션이 제공되어 값이 상수 값임을 나타내지 않는 한 비공개 클래스와 함수는 HTML 문서에 나타나지 않습니다. JavaScript는 값이 상수임을 실제로 보장할 수 없습니다.
@ignore JSDoc은 이 태그가 있는 함수를 무시합니다.

JsDoc: javascript 프로그램 소스에서 클래스, 메소드 및 멤버를 추출하는 js 문서 생성 도구입니다. code 주석 정보는 소스 코드와 일치하는 API 도움말 문서를 구성합니다.
강력한 자바스크립트 문서 생성 도구인 Java 오픈소스 프로젝트 http://www.jsdoctoolkit.org/.
이제 사용법을 마치겠습니다.
도구 라이브러리를 다운로드합니다.
여기에서는 현재 최고 버전인 jsdoc_toolkit-2.1.0.zip을 사용하고 있습니다.
이 파일의 압축을 풀어보겠습니다. 내부에 README.txt 파일이 있습니다.
자세한 사용 지침은 다음과 같습니다. [소개는 여기서 하면 될 것 같습니다. 물론 계속 읽어도 됩니다.]
여기서는 명령줄을 통해 자바스크립트 문서를 생성해야 합니다.
java -jar jsrun.jar app/run.js -a -e=GB18030 -t=templates/jsdoc test/*.js
물론 명령줄을 사용하는 것이 더 번거롭다면 .bat 파일을 직접 생성할 수 있습니다
위 내용을 파일에 복사해서 실행해 보세요.
매개변수에 대해 간단히 설명하겠습니다.
-a는 모든 메소드를 나타냅니다.
-e는 GB18030에 해당하는 해당 파일의 인코딩 루트를 나타냅니다. 기본값은 utf-8입니다.
-t 문서를 나타냅니다. 프로덕션 문서의 스타일 템플릿
여기서 test/*.js는 테스트 디렉터리의 모든 javascript 파일을 나타냅니다.
실행 후 문서 결과는 기본적으로 /out/jsdoc 디렉터리에 출력됩니다. 물론 이 디렉토리를 정의할 수도 있습니다.
특정 매개변수는
java -jar jsrun.jar app/run.js --help
를 사용하여 볼 수 있습니다.
결과는 다음과 같습니다.

코드는 다음과 같습니다.

/**
* @fileOverview 간단한 메소드 주석 예
* @author llying
* @version 0.1
*/

/**
* @description 추가 연산
* @param {Num} num1 addend
* @param {Num} num2 summand
* @return {Num} 결과 결과
*/
함수 추가(num1,num2){
return num1 num2;
/**
* @description 빼기 연산
* @param {Num} num1 minuend
* @param {Num} num2 minuend
* @return {Num} 결과 결과
*/
function minus(num1,num2){
return num1 - num2
}

클래스 메소드 주석
myjs2 .js

코드 복사 코드는 다음과 같습니다.

/**
* @fileOverview 간단한 클래스 객체 주석 예
* @author llying
* @version 0.1
* /
/**
* @author llying
* @constructor Person
* @description a Person 클래스
* @see llying. * @example new Parent("张三",15);
* @since 버전 0.1
* @param {String} 사용자 이름
* @param {Num} 나이 나이
*/
기능 사람(사용자 이름, 나이)
{
/**
* @description {Sting} 이름
* @field
*/
this.username = 사용자 이름
/ **
* @description {Num} 나이
* @field
*/
this.age = 연령
/**
* @description 팝업 내용 내용
* @param {String} 내용 내용
*/
this.say = 기능(콘텐츠)
{
alert(this.username " say : " content);
}
/**
* @description json 형식의 객체를 반환합니다.
* @return {String} json 형식
* @see Person#say
*/
this.getJson = function(){
return "{name:" this.username ",age" this. age " }";
}
}


이제 java -jar jsrun.jar app/run.js -a -e=GB18030 -t=templates/jsdoc test를 실행할 수 있습니다. /* .js

이제 js 문서가 생성되었습니다. 우리는 더 이상 JavaDoc을 부러워할 필요가 없습니다.


자세한 내용은 공식 웹사이트에 로그인하여 http://code.google.com/p/jsdoc-toolkit/을 참조하세요. 위키/태그 참조