【Node.js】自动生成 API 文档
warning:
这篇文章距离上次修改已过464天，其中的内容可能已经有所变动。
在Node.js中，可以使用jsdoc库来自动生成API文档。以下是一个简单的例子，展示如何使用jsdoc来生成API文档。
首先，安装jsdoc：
npm install -g jsdoc然后，创建一个名为example.js的文件，并添加一些使用JSDoc标记的注释：
/**
* 这是一个示例Node.js模块。
* @module example
*/
/**
* 加法函数。
* @param {number} a 加数。
* @param {number} b 加数。
* @return {number} 结果。
*/
function add(a, b) {
return a + b;
}
module.exports = {
add: add
};接下来，在命令行中运行jsdoc：
jsdoc example.js这将生成一个out目录，里面包含了HTML格式的API文档。打开out/index.html，就可以看到API文档了。
JSDoc还支持更多高级特性，比如配置文件、自定义标签和模板等。如需更详细的配置，可以创建一个jsdoc.json文件来指定配置选项。
评论已关闭