【问题标题】:Angular2 Documentation GeneratorAngular2 文档生成器
【发布时间】:2016-10-23 08:31:03
【问题描述】:

对于基于 typescript 的 Angular2-Projects,是否有像其他编程语言(jsdoc / phpdoc / javadoc / ..)一样的文档生成器(可能是节点包)?

【问题讨论】:

标签: typescript angular documentation-generation jsdoc


【解决方案1】:

如果您使用的是 TypeScript,那么“Typedoc.org”可能对您有用。 http://typedoc.org/

【讨论】:

  • 是的,它关门了。我会再找一个
  • 如果您打算使用 Typedoc,我建议您创建自己的约定,因为默认值非常基本。我们得到了一些灵​​感from here
【解决方案2】:

这似乎是一个可行的解决方案:compodoc

【讨论】:

  • 虽然理论上这可以回答这个问题,it would be preferable 在这里包含答案的基本部分,并提供链接以供参考。
  • 我发现compodoc-project 是最好的解决方案,以防你有一个angular2-project。该文档涵盖了您可能期望从好的文档中获得的所有内容,compodocs 可以识别 angular2 模块/类/服务/注释等,并相应地构建输出......另外,我发现包含的文档覆盖率报告非常有用。没有尝试使用纯打字稿项目,我猜这看起来像没有注释的“纯”类的输出。
  • 我发现这个工具最适合我的 Angular + TypeScript 项目。
猜你喜欢
  • 2015-10-27
  • 2021-06-21
  • 1970-01-01
  • 2015-06-04
  • 1970-01-01
  • 2017-02-18
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多