OBG WiKi

이 문서는 읽기 전용입니다. 원본을 볼 수는 있지만 바꿀 수는 없습니다. 문제가 있다고 생각하면 관리자에게 문의하세요.
====== JSDoc ======
문서화를 위한 툴

===== 변수 =====
<code javascript>
/**
 * secret key used in crypt() and decrypt()
 * @name secretKey
 */
var secretKey = "It should be defined";
</code>

name 속성은 명시하지 않아도 된다.

===== 함수 =====
<code javascript>
/**
 * @param {string} s - String to encode
 * @return {string} encoded string
 */
function crypt(s) {
    //some code
    return enc;
}
</code>

===== 클래스 =====
<code javascript>
/**
 * Define a cat
 * @class Cat
 */
var Cat = cc.Animal.extend({
    /**
     * constructor
     */
    ctor : function() {
        this._super();
    }
});
</code>

===== JsDoc Toolkit =====
자바로 짜여진 JSDoc 문서 자동 생성 코드. 자바 실행파일이 위치한 폴더를 운영체제의 PATH에 등록한 후 다음 명령을 실행한다.

<code>
java -jar jsrun.jar app/run.js {js 파일} -t=templates/jsdoc -d="{JSDoc 문서 폴더}"
</code>

아래의 명령은 ../src/*.js 파일들의 주석을 문서화하여 out 폴더에 저장한다.

<code>
java -jar jsrun.jar app/run.js ../src/*.js -t=templates/jsdoc -d="out"
</code>

===== 참고 =====
  * [[http://usejsdoc.org/|JSDoc 사용법 공식 홈페이지]]
  * [[https://code.google.com/p/jsdoc-toolkit/|jsdoc-toolkit]]
  * [[http://css.dzone.com/articles/introduction-jsdoc|An introduction to JSDoc]]
  * [[http://mohwaproject.tistory.com/entry/%EC%9E%90%EB%B0%94%EC%8A%A4%ED%81%AC%EB%A6%BD%ED%8A%B8-%EB%AC%B8%EC%84%9C%ED%99%94%EB%A5%BC-%EC%9C%84%ED%95%9C-jsdoc-toolkit-%EC%82%AC%EC%9A%A9%EB%B2%95-%EB%B0%8F-%EC%98%88%EC%A0%9C|자바스크립트 문서화를 위한 "jsdoc toolkit" 사용법 및 예제]]
  * [[http://kjkj.tistory.com/196|웹스톰을 이용한 JSDoc 자동 생성]]
  * [[http://www.speich.net/articles/2013/07/19/generate-javascript-documentation-with-jsdoc-3-and-phpstorm/|How to Generate JavaScript Documentation with JSDoc 3 and PhpStorm]]
  * [[http://keiaz.blog.me/130182834633|javadoc 사용법]]
  * [[http://techbug.tistory.com/110|자바스크립트 코딩가이드 #1]]
사용자 도구

문서 도구

OBG WiKi

사이트 도구
