JavaScript 的 API 文档生成

看公众号有一篇关于 JS 工具函数大全,心想着纳入我的博客中,又想起用过 vue-element-admin 中有个日期过滤器不错,也总结到一起,一看过滤器脚本中注释中有 @param 由此便引出了这篇博客。

JSDoc

什么是 JSDoc

JSDoc 3是用于JavaScript的API文档生成器,类似于Javadoc或phpDocumentor。您可以将代码注释直接添加到源代码中,并直接添加到源代码中。JSDoc工具将扫描您的源代码并为您生成一个HTML文档网站。
JSDoc的目的是记录您的JavaScript应用程序或库的API。假定您将要记录诸如模块,名称空间,类,方法,方法参数之类的内容。
JSDoc 注释一般应该放置在方法或函数声明之前,它必须以 / ** 开始,

使用 JSDoc

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/**
* Book类,代表一个书本.
* @constructor
* @param {string} title - 书本的标题.
* @param {string} author - 书本的作者.
*/
function Book(title, author) {
this.title = title;
this.author = author;
}
Book.prototype = {
/**
* 获取书本的标题
* @returns {string|*}
*/
getTitle: function () {
return this.title;
},
/**
* 设置书本的页数
* @param pageNum {number} 页数
*/
setPageNum: function (pageNum) {
this.pageNum = pageNum;
},
};
阅读更多
You need to set client_id and slot_id to show this AD unit. Please set it in _config.yml.