【问题标题】:Angularjs How to generate HTML code DocumentationAngularjs 如何生成 HTML 代码 文档
【发布时间】:2012-10-02 05:57:25
【问题描述】:

有没有人在记录/构建 angularjs 项目方面有任何经验,以便 JSDoc 可以以 HTML 格式生成漂亮的 cmets(用于您的指令、控制器、过滤器等)?目前,它会生成一个带有 _global 类的文件,该类指向我的应用程序的命名空间,其中包含几个函数,就是这样......

或者也许有更好的方法在 angularjs 中生成 html 版本的文档块?

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

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

谢谢!

【问题讨论】:

  • 有具体问题吗?
  • 作为一个问题可以吗(请参阅更新的内容和主题)?我花了很多时间来记录我的程序,而 JSDoc 命令行实用程序的 html 输出非常糟糕,甚至没有覆盖我应用程序的 5%...

标签: javascript angularjs jsdoc


【解决方案1】:

编辑:见下面的John David Five's answer

我的回答太老了,不应该再被接受了。

【讨论】:

  • 谢谢,我正在寻找的是一个正确记录的 Angular 应用程序,而不是 Angular 源代码,但仍然从那里学到了一些技巧......
  • 这是一个令人困惑的区别。他们的很多来源都在角度模块中,这是一个角度应用程序。那里有关于如何记录指令、过滤器、服务等的示例。
  • 您是否设法获得正确的输出?因为指令和过滤器是函数调用而不是函数定义,所以我想知道是否可以记录它们......
【解决方案2】:

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

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

【讨论】:

  • 这是一个更好的答案。如果可以的话,我会删除我的,但我不能,因为它已被接受。
  • 项目的主网站不见了。
  • @AaronHarun 无论如何,我的公司已经介入,我们现在正在赞助文档项目。该网站应该会在接下来的几天内备份,并且会有一个公司维护人员和一群渴望做出贡献的人。
  • @Stephen 我一直在尝试启动并运行文档作为 ngdocs 的替代方案,但我正在努力让它发挥作用。我们正在使用 yaml 来配置 grunt。这会引起问题吗?
  • @zpydee 不确定。请在问题列表(github.com/Vertafore/docular/issues)上留言部分配置详情,我今天就来看看。
【解决方案3】:

构建步骤:

文档将在build/docs 文件夹中提供。如果你有 PHP 5.5,你可以查看它:

  • cd 构建
  • php -S localhost:8000
  • 在浏览器中查看:http://localhost:8000/docs/index.html

【讨论】:

    猜你喜欢
    • 2010-09-27
    • 1970-01-01
    • 2020-10-22
    • 2019-08-26
    • 2022-12-15
    • 2011-02-17
    • 1970-01-01
    • 1970-01-01
    • 2012-11-11
    相关资源
    最近更新 更多