什么是 ngx-compodoc？
ngx-compodoc 是一个基于 Angular 版本 2 及以上的组件文档生成工具。它可以根据你的代码自动生成相应组件的文档，并提供一个易于浏览的界面展示该文档。它是一款非常优秀的前端开发工具。
ngx-compodoc 的使用步骤
第一步：安装 ngx-compodoc
在命令行中执行下面命令安装 ngx-compodoc：
npm i ngx-compodoc -g
第二步：编写项目
编写一个 Angular 项目。
第三步：生成文档
在命令行中进入项目根目录，执行如下命令：
compodoc -p src/tsconfig.app.json
该命令会在项目根目录下生成 docs 目录，即为生成的文档。
第四步：启动文档服务
在命令行中执行如下命令：
compodoc -s
该命令会启动文档服务，然后在浏览器中访问 http://localhost:8080 就可以看到生成的文档。
深入了解 ngx-compodoc
生成文档配置
你可以在项目中的 tsconfig.json 或者 compodoc.json 中添加如下配置来改变生成文档的方式：
-- -------------------- ---- -------
-
----------- -
--------- -------
-------- ----------
----------- --------------
-------- -----------
---------------- -----
-------------------- ------
----------------- -----
--------------------- -----
------------------ -----
---------------------- -----
----------------- ------
--------------- -----
------------------ -----
----------------- -----
------------------- -----
------------------ -----
------------------------ -----
--------------------- -----
---------------- -----
------------------------ -----
------------------------ ---
------------------- ----
----------- --------
------------------ -----------
---------------- -----
-------------- --------
--------- --------------
--------------- -----------
------------- ---------------------
------------------ -
------------- -
----------- --------------
-------------------- -----
--------------- ------
------------ ------------------
-------------------- ------
--
----------- -
------- -------------
---------- ---------------
-
-
-
-根据需求，修改对应的选项即可。
示例代码
在 src/app 目录下添加一个名为 hello 的组件：
-- -------------------- ---- ------- ------ - --------- - ---- ---------------- ------------ --------- ------------ --------- ---------- ---------------- -- ------ ----- -------------- - ---- - ------- -
然后执行 compodoc -p src/tsconfig.app.json，浏览器中访问 http://localhost:8080 即可看到生成的文档，其中包含了 app-hello 组件的文档信息。
以上是本文对于 ngx-compodoc 的详细介绍和使用教程，希望能为大家提供帮助，使大家更好地进行前端开发。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056bea81e8991b448e5a70