哪个注释文档格式更适合JavaScript？

Question

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

目前我正在使用VSDoc xml注释在开发时提供智能感知帮助，但据我所知，没有这种注释的文档生成器。 所以或者我的问题听起来像这样：是否有任何实用工具将VSDoc评论从JavaScript文件转换为HTML？

Answer 1

你看过自动生成的文档从JavaDoc或VSDoc或JSDoc或类似的东西。

它们都是丑陋的和不可读的。

的解决方案是双重的

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

还有第三种选择是彻底改变我们自动生成文档的方式，如果可以的话请做。

Answer 2

我用Natural Docs为几个项目。这个语法对于阅读内联是很好的，但是由于它没有JavaScript的“全面语言支持”，所以你必须对每个函数/常量/类/你想要记录的内容做些清晰的说明。

Answer 3

有一个分析JavaScript文件，并将其输出的XML格式NDoc的和沙堡使用的实用程序：AjaxDoc

你从相同的意见VS智能感知，并且可以输出所需的任何格式的方式。