compodoc 自动文档生成命令

[luohong123]

自动文档生成命令
doc官网

第一步：全局安装@compodoc/compodoc

执行命令： npm i @compodoc/compodoc@1.1.5 -g

第二步：

项目本地安装@compodoc/compodoc
执行命令：

npm i @compodoc/compodoc@1.1.5 -save --dev

第三步：

在git工具上输入命令

compodoc -p src/tsconfig.app.json --theme postmark --disableSourceCode --disableGraph --disableTemplateTab --disableDomTree --disableCoverage --disablePrivate --disableProtected --disableInternal --disableLifeCycleHooks --hideGenerator --language zh-CN -n \"fccomponent2组件API文档\"

注释替换 // 替换成/** /正则表达式 //([^\r\n]) 替换成 /**$1*/
npm run docsimpe
-h， - help 输出使用信息
-V， - 版本 输出版本号
-c， - config [config] 一个配置文件：.compodocrc，.compodocrc.json，.compodocrc.yaml或package.json中的compodoc属性
-p， - tsconfig [config] 一个tsconfig.json文件
-d， - output [文件夹] 存储生成的文档的位置
-y， - textTheme [file] 外部造型主题
-n， - name [name] 文件标题
-a， - fromsFolder [文件夹] 外部资产文件夹，用于复制生成的文档文件夹
-o， - 开 打开生成的文档
-t， - silent 在静默模式下，日志消息不会记录在控制台中
-s， - 提供生成的文档（默认http：// localhost：8080 /）
-r， - port [port] 更改默认服务端口
-w， - 手表 在serve和force documentation rebuild之后观察源文件
-e， - exportFormat [格式] 以指定格式导出（json，html（默认））

• 主题[主题] 选择一个可用主题，默认为'gitbook'（laravel，original，material，postmark，readthedocs，stripe，vagrant）
  --hideGenerator 不要在页面底部打印Compodoc徽标
  --toggleMenuItems 关闭菜单中的默认项目（默认['all']）值：['all']或其中一个['modules'，'components'，'directives'，'classes'，'injectables'，'interfaces' ， '管道'， 'additionalPages']）
  --navTabConfig 使用两个字符串属性（“id”和“label”）按所需顺序列出导航选项卡对象。双引号必须使用''进行转义。可用的选项卡ID是“info”，“readme”，“source”，“templateData”，“tree”和“example”。注意：仅在适用于给定依赖项时才会显示某些选项卡
  --templates [文件夹] Handlebars模板目录的路径，用于覆盖内置模板
• 包括[路径] 要包含的外部markdown文件的路径
  --includesName [name] 外部降价文件的项目菜单名称（默认“附加文档”）
  --coverageTest 使用阈值测试文档覆盖率命令（默认为70）
  --coverageMinimumPerFile [minimum] 每个文件的文档覆盖率测试命令至少（默认为0）
  --coverageTestThresholdFail [boolean] 文档覆盖率（全局或每个文件）的测试命令将失败并显示错误或仅警告用户（true：error，false：warn）（默认值：true）
  --coverageTestShowOnlyFailed 仅显示覆盖测试的失败文件
  --unitTestCoverage [json-summary] 要包含单元测试覆盖率，请指定istanbul JSON覆盖率摘要文件
  --disableSourceCode 不要添加源代码选项卡和源代码链接
  --disableDomTree 不要添加dom树选项卡
  --disableTemplateTab 不要添加模板选项卡
  --disableGraph 禁用依赖关系图的呈现
  --disableCoverage 不要添加文档覆盖率报告
  --disablePrivate 不要在生成的文档中显示私有
  --disableProtected 不要在生成的文档中显示受保护
  --disableInternal 不要在生成的文档中显示@internal
  --disableLifeCycleHooks 不要在生成的文档中显示Angular生命周期钩子
  --disableRoutesGraph 不要添加路线图
  --disableSearch 不要添加搜索输入
  --minimal 最小模式，只有文档。没有搜索，没有图表，没有覆盖。
  --customFavicon [路径] 使用自定义图标
  --gaID [id] Google Analytics跟踪ID
  --gaSite [网站] Google Analytics网站名称（默认自动（默认：自动））