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辅助下载,werplan外卦神器,可靠教程(素来存在有挂);科技安装教程;...
透视存在!wepoker透视脚... 透视存在!wepoker透视脚本免费下载,pokeplus脚本,我来教教你(原来存在有挂);wepo...
透视讲解!wepoker作弊辅... 透视讲解!wepoker作弊辅助,aapoker透视脚本,透明挂教程(果然真的有挂);亲,其实确实真...
辅助透视!德普之星有没有挂,w... 辅助透视!德普之星有没有挂,wepoker透视脚本苹果版,2025新版总结(果然是真的有挂)科技教程...
透视软件!wpk透视表,约局吧... 透视软件!wpk透视表,约局吧开挂神器是真的吗,曝光教程(都是存在有挂);人气非常高,ai更新快且高...
透视挂透视!智星德州菠萝透视插... 透视挂透视!智星德州菠萝透视插件工具,德普辅助器辅助器怎么用,德州论坛(本然是真的有挂);大神普及一...
透视系统!aapoker辅助插... 透视系统!aapoker辅助插件工具,aapoker透视脚本,力荐教程(果然是真的有挂);原来确实真...
透视攻略!hhpoker透视方... 透视攻略!hhpoker透视方法,aapoker免费透视脚本,透明挂教程(真是有挂);最新版2024...
透视数据!aapoker可以开... 透视数据!aapoker可以开挂吗,wepoker透视脚本是什么,普及教程(从前有挂);《WPK辅助...
透视辅助!aapoker辅助插... 1、透视辅助!aapoker辅助插件工具,德普之星辅助软件,可靠教程(原先真的是有挂);详细教程。2...