程序员之间的一个共同分歧点是代码注释的重要性。一些人认为代码在完全注释之前是不完整的。其他人认为，编写良好的代码应该不需要额外的信息——它是自我记录的。无论您站在栅栏的哪一边，有时您都会发现自己需要根据您的代码生成文档——例如，在编写将以黑盒方式使用的 API 时。 Back& 团队查看了许多针对 JavaScript 项目的不同文档产品。这是我们的发现。
NG文档
AngularJS 依赖于一种称为 NGDoc 的 JSDoc。 NGDoc 通过添加几个特定于角度的注释指令来构建 JSDoc 中提供的功能，这些注释指令可以添加到您的类和函数头中。这些允许您的文档更准确地反映代码，特别是考虑到 AngularJS 应用程序往往具有与许多其他类型的 Web 应用程序显着不同的架构。 NGDoc 文档通常是使用 Grunt 构建的。
多科
Docco 是一种快速而简单的文档方案，可以处理降价格式以及 JavaScript 的语法高亮显示。它是高度可配置的，这使得它既灵活又给它一个陡峭的学习曲线。 Docco 的好处之一是它并不严格限于 JavaScript——该库的版本适用于 Ruby、Python、Clojure 等。 Docco 通常作为自己的工具从命令行运行，因此它很可能被集成到大多数构建和部署脚本中。
多克斯
Doxx 是一个专注于创建漂亮的 HTML 文档的文档产品。它依靠 HTML 模板和 CSS 来创建基于 Twitter Bootstrap 的结果文档，并通过使用 Prism.js 提供语法高亮显示。它可用于 JavaScript 或 CoffeeScript，并且最常使用 Grunt 构建。
YUI文档
YUIDoc 是一个 Node.js 应用程序，它使用类似于 Javadoc 和 Doxygen 的语法为您的代码生成 HTML 文档。它具有实时预览、支持 Markdown 语法和支持多种语言的特点。它作为第三方工具安装，并从项目源代码文件夹根目录下的命令行运行。虽然它最初是为 YUI 项目开发的，但它可以用于任何语言使用 /* ... 的项目。 */ 征求意见。
结论
选择自动文档工具通常是一个偏好问题。许多开发人员倾向于使用他们过去使用过的东西，而其他人则一直在寻找下一个能够解决他们所有问题的伟大框架。虽然这两种方法在 100% 的情况下都是不可取的，但这些产品之间存在一些功能差异，从表面上看，它们都做完全相同的事情。在这方面，NGDoc 以其对 Angular 的许多特性的原生支持，通常是 AngularJS 应用程序的不错选择。也就是说，指令支持不一定是您文档的主要目标。最终，最好的文档产品是最准确地反映您希望用户看到的文档的产品，因此最好的选择可能只是“任何有效的东西”。
获得一个免费托管的 AngularJS 后端，它具有用户管理、社交登录、支付集成、安全等功能—— 现在就开始吧。
