Angular 文档生成:使用 compodoc 生成 Angular2+ 源码组件的 API 文档

compodoc 是针对 angular2+ 设计的 API 文档生成工具,其最大的特点是使用简单,生成文档全面美观。 1 compodoc 的优缺点 API 文档主要的作用一般有: 方便快速了解整体的模块、组件依赖、项目架构等 方便 API 文档快速查阅 利于重复方法、变量等的分析,优化项目结构( Miscellaneous) 项目质量跟踪,文档覆盖率统计分析(Documentation cov
Angular 文档生成:使用  compodoc 生成 Angular2+ 源码组件的 API 文档

使用 JSDoc 与 docstrap 生成 JavaScript 项目 API 文档

JSDoc 规范是 JavaScript 最为流行的一套 JS 注释规范,许多 IDE 编辑器都对其提供内核或插件级别的支持。 根据 JSDoc 规范书写注释的 JavaScript 文件,可以借助 JSDoc 工具生成标准的使用文档,也可以被 IDE 编辑器用于代码提示。 JSDoc 默认的文档模板比较单调,docstrap 提供了 14+ 种 bootstrap 风格的模板,使用 docstrap 使得生成的文档更美观易用。 下面志文工作室针对 JSDoc 与 docstrap 安装使用的方法与要点作简要介绍。
使用 JSDoc 与 docstrap 生成 JavaScript 项目 API 文档