Angular-JSDoc是一个基于JSDoc注释以及Angular的特定语法的文档生成器。它可以通过读取代码中的注释来自动生成文档，并提供了一个非常易用的UI展示页面。在这篇文章中，我们会详细讲解如何使用npm包angular-jsdoc。
安装Angular-JSDoc
使用npm安装Angular-JSDoc很简单，只需要执行一下命令即可：
npm install angular-jsdoc --save-dev
添加"-dev"参数是因为这是一个仅用于开发环境的包（devDependencies）。
编写注释
在使用Angular-JSDoc生成文档之前，需要在代码中添加一些特定的注释，让Angular-JSDoc知道如何生成文档。这些注释有点类似于Javadoc或其他语言的文档注释。
在Angular项目中，我们通常会在Controller、Service、Filter、Directive等中添加注释。
以Controller为例，以下是一个基本的示例：
-- -------------------- ---- -------
---
- ------ ----------
- ----- ------------
-
- ------------
- ---- -- - ----------- -- -------------
--
--------------------------
--------------------------- ---------- -
-- ---------- ----
---注释中包含了一些特殊的标签，例如@ngdoc、@name和@description。这些标签告诉Angular-JSDoc如何来处理该注释。
需要注意的是，在添加注释时一定要严格按照标签的格式来编写。
生成文档
添加完注释后，我们可以使用Angular-JSDoc来生成我们的文档了。执行以下命令：
./node_modules/angular-jsdoc/node_modules/.bin/jsdoc -c jsdoc.conf.json
这条命令会使用jsdoc.conf.json文件中的配置生成文档，该文件包含了一些配置参数，例如生成文档的路径、模板等。具体配置可参考官方文档。
生成好的文档会默认输出到./out目录下，我们可以通过修改配置文件来修改生成路径。
展示文档
最后，我们需要一个展示文档的UI界面。在我们的应用程序中，我们可以使用Angular-JSDoc提供的预制界面，或自定义界面。
在这里，我们将使用Angular-JSDoc自带的预制UI，在页面添加以下代码即可：
-- -------------------- ---- -------
--------- -----
----- -----------------
------
------- ------------------------------
------- ------------------------------
-------
----- ----------------------------- -- ----------
---- ---------------
---------------------------
------
---- ----------- --------------------------------------------
---- --------------- --------------
-------
-------该代码会加载AngularJS并使用docsApp模块。这个模块由Angular-JSDoc自动生成，并将文档渲染在ng-view元素中。
示例代码
下面是一个完整的使用示例：
-- -------------------- ---- -------
---
- ------ ----------
- ----- ------------
-
- ------------
- ---- -- - ----------- -- -------------
--
--------------------------
--------------------------- ---------- -
-- ---------- ----
----- -------------------- ---- -------
-
------- -
------------------- -----
--------------- --------- ----------
--
--------- -
---------- ---------- -------------
----------------- -------
----------------- ----------------------
--
---------- -
------------------
--
------------ -
-------------- ------
----------------- ------
---------- -
-------------------- ----
-
--
------- -
-------------- ------------
---------- ----
-
--- -------------------- ---- -------
--------- -----
----- -----------------
------
------- ------------------------------
------- ------------------------------
-------
----- ----------------------------- -- ----------
---- ---------------
---------------------------
------
---- ----------- --------------------------------------------
---- --------------- --------------
-------
-------使用以上示例即可在你的AngularJS项目中使用Angular-JSDoc生成文档并展示。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedcae8b5cbfe1ea0612500