Angularjs如何生成HTML代码文档

时间:2012-10-11 14:22:09

标签: javascript angularjs jsdoc

有没有人在记录/构造angularjs项目方面有经验,所以JSDoc可以用HTML格式生成好的评论(对于你的指令,控制器,过滤器等)?目前它使用_global类生成一个文件,该文件指向具有几个函数的应用程序的命名空间,就是这样......

或许有更好的方法可以在angularjs中生成html版本的doc块?

PS:我使用标准的jsdoc语法来记录我的代码(@ param,@ return等)

更新:我的具体问题是:有没有办法生成angularjs doc块的html文档来覆盖所有控制器/指令/过滤器等?当运行JSDoc命令行实用程序时,它只覆盖HTML报告中约5%的代码...

谢谢!

3 个答案:

答案 0 :(得分:33)

我一直在研究一个利用AngularJS文档生成代码的grunt插件。它遵循它们的语法和输出。 grunt-docular。该链接显示了docular源的文档生成以及原始的AngularJS源。它是可配置和可扩展的。

转到grunt-docular并找到安装链接,以获取创建自己文档的示例

答案 1 :(得分:4)

编辑:请参阅下面的John David Five's answer

我的答案更长,更老,不应再被接受了。

答案 2 :(得分:1)

构建步骤:

文档可在build/docs文件夹中找到。如果你有PHP 5.5,你可以用以下方式查看:

  • cd build
  • php -S localhost:8000
  • 在浏览器中查看:http://localhost:8000/docs/index.html
相关问题