[Script] Dox 에 대해 알아본다. ( Dox Output에 대한 설명 )

출처 : http://jsdoc.info/visionmedia/dox/

Dox 는?

- Dox는 node로 쓰여진 코드를 document 로 생성하는 JavaScript 코드.

- JSON 형태로 output이 나오며, template에 전달되어 HTML 문서 등으로 전환 될 수 있다. 

Usage Examples

$ dox < myfile.js
  .... JSON Result ... 

$ doc < myfile.js > myfile.json

Properties

- comment 는 다음으로 나뉘어진다. 

 1. tags

 2. description

 3. isPrivate

 4. ignore

 5. code

 6. ctx

Description

- description 쪽은 "full", "summary", "body" 로 구성된다. 

- "summary" 는 first paragraph. 나머지는 "body", "full"은 전체

- markdown을 사용하기 때문에 code indent를 사용할 수 있다. code indent르 list, link 등을 표현할 수 있다.

Tags

- JSdoc style 의 tag를 제공한다.

- @api 가 있으면 comment.isPrivate 이 boolean 형태로 기술된다.

- @param {String} str for string 이 주어지면 아래의 output이 나온다.

tags:[

    { type:'param',

      types:['String'],

      name:'str',

      description:'for string' },

    { type:'api',

      visibility:'public' }

  ]

Codes

- code property는 주석 다음에 오는 코드 block 이 된다.

Ctx

- ctx 는 code block의 context를 나타낸다. 이것이 method인지, function인지, variable인지.

- exports.write = function( str, options ){}; 의 경우는 아래의 output

  ctx:{

    type:'method'

    receiver:'exports',

    name:'write',

    string:'exports.write()'

  }

 
 - var foo = 'bar'; 는 아래의 output이 나온다.

  ctx:{

    type:'declaration',

    name:'foo'

    value:'\'bar\'',

    string:'foo'

  }

 
- function User(){ } 는 아래의 output

  ctx:{

    type:'function',

    name:'User',

    string:'User()'

  }

 

Ignore

- comment 와 code는 ! 를 통해 ignore-flaged 될 수 있다. ignore-flaged 되면 dox는 이 comment와 code body를 무시한다. 

도움이 되셨다면 손가락 꾸욱~ ( 로그인 필요 x )