如何记录AngularJS指令



是否有任何专门的标准或工具用于记录AngularJS指令?我们正在明确构建可重用功能,因此我们应该能够将它们的接口传达给开发人员。我看到了一些东西:

  • Swagger。我喜欢Swagger 2.0的发展方向,但不清楚它将如何用于记录指令
  • Ngdoc(https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation)它的优点是与AngularJS团队使用的工具相同

人们找到了更好的方法吗?

看看angular的来源,那里的注释是用来在angular网站上生成文档的

在这个grunt插件中使用了类似的方法:https://github.com/Vertafore/grunt-docular

这就是我们在工作时使用的

最新更新