【发布时间】:2016-05-12 23:54:50
【问题描述】:
我想为我正在构建的框架创建一个自动生成的 JSDoc 文档文件,但似乎找不到输出文档的方法。 是否可以将文档输出为 JSON 或 HTML?还是我必须使用 RegExp 构建自己的 JSDoc 解析器?
我浏览了整个网络,但找不到任何关于该主题的内容。
谢谢。
【问题讨论】:
-
Uhm: "一旦你的代码被注释了,你就可以使用JSDoc 3 Tool从源代码生成一个HTML网站。默认情况下,JSDoc会使用“默认”模板来转文档数据转换为 HTML。您可以编辑此模板以满足您自己的需要,或者如果您愿意,可以创建一个全新的模板。
./jsdoc book.js此命令将在当前工作目录中创建一个名为“out”的文件夹。在那个你会找到生成的 HTML 页面。” usejsdoc.org/about-getting-started.html ... 好像你浏览了整个网络而不是官方文档? -
总是先看看官方文档。
-
@FelixKling 谢谢!过去 3 天我一直在寻找...从未找到该页面。
-
JSDoc 文档是糟糕的 IMO。有点好笑。
-
奇怪的是,该 jsdoc 网站上没有关于从何处下载实际工具/二进制文件的信息
标签: javascript documentation-generation jsdoc