哪种评论文档格式更适合JavaScript？

Question

对于生成HTML文档的格式，JavaScript和处理器是否有任何注释文档格式？

目前我正在使用VSDoc xml注释在开发时提供IntelliSense帮助，但据我所知，此类注释没有文档生成器。 所以，我的问题可能听起来像：是否有任何实用程序将VSDoc注释从JavaScript文件转换为HTML？

Answer 1

您是否查看过JavaDoc或VSDoc或JSDoc或类似内容的自动生成的文档。

它们都很丑陋且无法读取。

解决方案是两倍

• annotate your code with docco
• 手写您的API文档。

如果可以的话，还有第三个选项可以彻底改变我们自动生成文档的方式。

Answer 2

我已将Natural Docs用于一些项目。语法非常适合读取内联，但由于它没有JavaScript的“完全语言支持”，因此您必须对每个函数/常量/类/您想要记录的内容有所了解。

Answer 3

有一个实用程序解析Javascript文件并输出相同的XML格式NDoc和Sandcastle使用：AjaxDoc

这样你就能从相同的评论中获得VS intellisense，并可以输出你想要的任何格式。