开发文档是很有价值的,然而制作和更新文档却不是轻松活。
在JAVA中,有javadoc工具,可以一键提取注释并生成文档。在其它语言中,就不一定这么方便了。
这里介绍一个工具,jsdoc, 可以提取javascript文件里面的注释并生成美观的html文档。
jsdoc识别类似于JAVA的注释标签,如@author、@param、@method等。例如:
/**
* Represents a book.
* @constructor
* @param {string} title - The title of the book.
* @param {string} author - The author of the book.
*/
function Book(title, author) {
}
通过配置文件,可以提供更多选项:
{
"tags": {
"allowU