如何在 angular 中编写我的函数的文档
How to write documentation of my functions in angular
我想为我的 Angular 项目编写文档。谁能指导我为 Angular 编写文档的默认方式是什么?我在网上搜索过,但找不到任何答案。我只找到了与 compodoc
有关的内容。但是我想记录我项目的每一个功能。
如果您正在构建 AngularJS (1.x) 项目:
许多 javascript 开发人员使用 JSDoc 作为记录其代码的方式 (http://usejsdoc.org/)。
如果您正在构建一个 Angular(2+) 项目:
微软发布了 typescript 项目的标准:https://github.com/Microsoft/tsdoc
我想为我的 Angular 项目编写文档。谁能指导我为 Angular 编写文档的默认方式是什么?我在网上搜索过,但找不到任何答案。我只找到了与 compodoc
有关的内容。但是我想记录我项目的每一个功能。
如果您正在构建 AngularJS (1.x) 项目: 许多 javascript 开发人员使用 JSDoc 作为记录其代码的方式 (http://usejsdoc.org/)。
如果您正在构建一个 Angular(2+) 项目: 微软发布了 typescript 项目的标准:https://github.com/Microsoft/tsdoc