apidoc不排除排除模式
创始人
2024-09-07 12:30:25
0

apidoc是一个生成API文档的工具,可以通过注释来生成API文档。默认情况下,apidoc会排除掉注释中以@开头的特殊注释,例如@ignore和@exclude。

如果你想要使用apidoc的排除模式,但又不想排除掉特殊注释,可以按照以下步骤修改apidoc的配置:

  1. 打开apidoc.json或apidoc.js配置文件,可以在项目根目录找到这些文件。
  2. 在配置文件中找到"parse"字段,该字段用于配置apidoc的解析规则。
  3. 在"parse"字段中添加一个"exclude"字段,并将它设置为false,表示不排除任何注释。
  4. 保存配置文件并重新运行apidoc命令。

以下是一个示例apidoc.json配置文件的修改示例:

{
  "name": "My API",
  "version": "1.0.0",
  "description": "API documentation",
  "title": "My API",
  "url": "http://example.com",
  "template": {
    "withCompare": false,
    "forceLanguage": "zh-cn"
  },
  "parse": {
    "exclude": false,
    "includeFilters": [
      ".+\\.js$"
    ],
    "excludeFilters": [
      "node_modules/"
    ]
  },
  "markdown": {
    "parser": "marked",
    "renderer": {}
  }
}

在上述示例中,"parse"字段中添加了"exclude"字段,并将其设置为false,表示不排除任何注释。

通过以上修改,apidoc将不再排除任何注释,包括特殊注释。重新运行apidoc命令后,你将会看到所有的注释都被包括在生成的API文档中。

相关内容

热门资讯

交流学习经验!德扑输赢概率计算... 1、交流学习经验!德扑输赢概率计算器(wEPOKE)的确是真的有挂(辅助该)技巧教程(有挂透视)-哔...
一起来讨论!德扑之星ai代打(... WePoker透视辅助工具核心要点解析‌,一起来讨论!德扑之星ai代打(透视)的确真的有挂(详细教程...
揭秘一下(aAPOKER)外挂... 揭秘一下(aAPOKER)外挂透明挂辅助工具(辅助透视)详细教程((2021已更新))(哔哩哔哩)准...
5分钟了解(WPK工具)外挂辅... 1、5分钟了解(WPK工具)外挂辅助挂(辅助挂)其实真的有挂(2020已更新)(哔哩哔哩);详细教程...
技术分享!轰趴大菠萝十三水辅助... 技术分享!轰趴大菠萝十三水辅助(Wepoke实测)竟然真的有挂(辅助该)详细教程(有挂神器)-哔哩哔...
一分钟了解(德州免费)外挂透明... 德州免费透视辅助版本稳定性对比与推荐‌:一分钟了解(德州免费)外挂透明挂辅助挂(透视辅助)详细教程(...
避坑细节!红龙扑克都是机器人(... 避坑细节!红龙扑克都是机器人(辅助挂)其实是真的有挂(详细教程)(有挂攻略)-哔哩哔哩;红龙扑克都是...
科普(线上wpk德州)外挂辅助... 科普(线上wpk德州)外挂辅助机制(透视)确实是真的有挂(2021已更新)(哔哩哔哩)相信很多朋友都...
重大来袭(pokerworld... 重大来袭(pokerworld软件)外挂透明挂辅助机制(辅助透视)详细教程((2024已更新))(哔...
教学盘点!德州之星辅助(透视)... 教学盘点!德州之星辅助(透视)其实真的有挂(详细教程)(有挂总结)-哔哩哔哩1、很好的工具软件,可以...