是否有 JavaScript 的注释文档格式和生成 HTML 文档的这种格式的处理器？
目前，我正在使用 VSDoc xml 注释在开发时提供 IntelliSense 帮助，但据我所知，没有此类注释的文档生成器。因此，或者我的问题可能听起来像：是否有任何实用程序可以将 VSDoc 注释从 JavaScript 文件转换为 HTML？
问问题
2943 次
3 回答
9
您是否查看过来自 JavaDoc、VSDoc 或 JSDoc 或类似内容的自动生成文档。
它们都丑陋且不可读。
解决方案有两个
- 用 docco 注释你的代码
- 手写您的 API 文档。
第三种选择是彻底改变我们自动生成文档的方式，如果可以的话，请这样做。
于 2011-09-24T16:40:07.423 回答
1
我在几个项目中使用过Natural Docs。该语法很适合阅读内联，但由于它没有对 JavaScript 的“完整语言支持”，因此您必须对每个函数/常量/类/您想要记录的任何内容都有些明确。
于 2011-09-24T19:27:10.757 回答
1
有一个实用程序可以解析 Javascript 文件并输出 NDoc 和 Sandcastle 使用的相同 XML 格式：AjaxDoc
这样您就可以从相同的评论中获得 VS 智能感知，并且可以输出您想要的任何格式。
于 2012-02-22T17:29:27.260 回答