如何用角度编写我的函数的文档

时间:2019-04-22 14:24:10

标签: angular documentation

我想写我的Angular项目的文档。谁能指导我为Angular编写文档的默认方式是什么?我已经在线搜索了它,但是找不到任何答案。我发现的所有东西与compodoc有关。但是我想记录项目的每个功能。

1 个答案:

答案 0 :(得分:1)

如果您要构建AngularJS(1.x)项目: 许多JavaScript开发人员使用JSDoc作为记录其代码(http://usejsdoc.org/)的方式。

如果您要构建Angular(2+)项目: 微软发布了打字稿项目的标准:https://github.com/Microsoft/tsdoc