JS源文件的文档注释与提取

本文介绍了如何使用jsdoc和jsdox工具从JavaScript源文件中的注释生成文档。jsdoc提供了一种类似javadoc的方式,通过识别特定注释标签来生成HTML文档,支持目录递归和自定义模板。而jsdox则可以生成Markdown格式的文档,适用于单个或整个目录的注释提取。
摘要由CSDN通过智能技术生成

开发文档是很有价值的,然而制作和更新文档却不是轻松活。

在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
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值