4. Overview docco JsDoc-Toolkit
...
.............
.....
docco
Docco is a quick-and-dirty, hundred-line-long,
literate-programming-style documentation generator.
It produces HTML that displays your comments
alongside your code. Comments are passed through
Markdown, and code is passed through Pygments
syntax highlighting. This page is the result of
running Docco against its own source file.
. . . . . .
@yyfrankyy Yet Another JavaScript Programmer f2e.us
JsDoc的使用
7. Overview docco JsDoc-Toolkit
...
.............
.....
Introduction
jsdoc-toolkit
JsDoc Toolkit is an application, written in
JavaScript, for automatically generating
template-formatted, multi-page HTML (or XML, JSON,
or any other text-based) documentation from
commented JavaScript source code.
. . . . . .
@yyfrankyy Yet Another JavaScript Programmer f2e.us
JsDoc的使用
19. Overview docco JsDoc-Toolkit
...
.............
.....
Annotations
@description/@example
无tag的信息并入@description。
可通过@link/@see进行相互链接。
@example输出<pre/>标签。
顺序解析,直接转为html(无换行),有markdown插件。
Example
/**
* name of this account.
* @description
* other desc.
* @example
* Form.add("hello");
*/ . . . . . .
@yyfrankyy Yet Another JavaScript Programmer f2e.us
JsDoc的使用
20. Overview docco JsDoc-Toolkit
...
.............
.....
Annotations
@description/@example
无tag的信息并入@description。
可通过@link/@see进行相互链接。
@example输出<pre/>标签。
顺序解析,直接转为html(无换行),有markdown插件。
Example
/**
* name of this account.
* @description
* other desc.
* @example
* Form.add("hello");
*/ . . . . . .
@yyfrankyy Yet Another JavaScript Programmer f2e.us
JsDoc的使用
21. Overview docco JsDoc-Toolkit
...
.............
.....
Annotations
@description/@example
无tag的信息并入@description。
可通过@link/@see进行相互链接。
@example输出<pre/>标签。
顺序解析,直接转为html(无换行),有markdown插件。
Example Example
/**
* name of this account. name of this account.
* @description other desc.
* other desc.
* @example Form.add("hello");
* Form.add("hello");
*/ . . . . . .
@yyfrankyy Yet Another JavaScript Programmer f2e.us
JsDoc的使用