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文档中。

相关内容

热门资讯

透视插件!wepoker可以设... 透视插件!wepoker可以设置盖牌-关于开挂透视辅助教程(有挂教学)透视插件!wepoker可以设...
最新技巧“浙江游戏大厅修改器”... 最新技巧“浙江游戏大厅修改器”原先有开挂辅助挂(确实有挂);1、这是跨平台的浙江游戏大厅修改器黑科技...
透视挂透视!hhpoker可以... 透视挂透视!hhpoker可以开挂-揭露开挂透视辅助攻略(有挂攻略)1、hhpoker可以开挂系统规...
玩家必看分享“小程序微乐游戏辅... 玩家必看分享“小程序微乐游戏辅助器”其实有开挂辅助器(详细教程);1、让任何用户在无需AI插件第三方...
透视工具!wepoker国外版... 透视工具!wepoker国外版透视-教你开挂透视辅助工具(了解有挂)1、全新机制【wepoker国外...
专业讨论“欢乐游戏城破解版内置... 专业讨论“欢乐游戏城破解版内置修改器”本来有开挂辅助脚本(了解有挂);详细欢乐游戏城破解版内置修改器...
一分钟教你“宝宝游戏辅助”好像... 您好:宝宝游戏辅助这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很多用户的牌特别...
透视最新!hhpoker透视挂... 透视最新!hhpoker透视挂实战视频-解谜开挂透视辅助攻略(有挂技术)1、超多福利:超高返利,海量...
9分钟了解“四川家园游戏辅助器... 9分钟了解“四川家园游戏辅助器平台交易”果然有开挂辅助下载(有挂规律);亲真的是有正版授权,小编(透...
透视科技!wepoker智能辅... 透视科技!wepoker智能辅助插件-教你开挂透视辅助插件(有挂方针)1、进入到wepoker智能辅...