随着前端工程化进程的不断提升，前端开发的标准化和规范化也越来越重要，而文档编写则是其中不可缺少的一部分。angulardoc 就是一个为 Angular 手动编写文档提供自动化工具的 npm 包，它可以将代码和文档集成在一起，便于项目维护和文档撰写。
安装和使用
安装 angulardoc 很简单，只需要在终端中输入以下命令即可：
npm install -g angulardoc
使用 angulardoc 的步骤也很简单，具体流程如下：
新建一个普通的 Angular 应用程序
ng new my-doc-app cd my-doc-app
安装 angulardoc
npm install angulardoc --save-dev
新建一个名为 docs 的文件夹，用来存储文档
mkdir docs
在根模块的 app.module.ts 文件中引入 angulardoc
import { angulardoc } from 'angulardoc';将 angulardoc 注册到 AppModule 中
@NgModule({ declarations: [AppComponent], imports: [BrowserModule, angulardoc.forRoot()], providers: [], bootstrap: [AppComponent] }) export class AppModule {}在 docs 文件夹中新建以组件名称为名字的 Markdown 文件，并将组件信息写入到 Markdown 文件中
-- -------------------- ---- ------- - ----------- ---- -- -- ---------- -- ------ - ---- - ---- - ----------- - ----------------------------- - ---- - ------ - --- ---- -- --- ---------- - -- ------- -- -------- -- ------- ------- ----------------- --------------------------------
运行打包命令，生成文档
npm run docs
打开浏览器，访问 http://localhost:8080/docs，即可看到生成的文档
示例代码
这是一个简单的 MyComponent 组件，例子展示了如何在 Markdown 中编写组件信息。
-- -------------------- ---- -------
------ - ---------- ----- - ---- ----------------
------------
--------- -------------------
--------- -
--------- --------------
-
--
------ ----- ----------- -
-------- ----- -------
-总结
angulardoc 是一个非常方便的生成 Angular 组件文档的工具，只需要编写简单的 Markdown 文件即可生成规范化文档，十分适合用于实际的项目开发。希望本文可以帮助大家更好地使用 angulardoc。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600573d881e8991b448e9c3d