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

相关内容

热门资讯

透视免费!poker mast... 透视免费!poker master安卓版外挂(透视)竟然真的有挂(详细教程)(有挂教学)-哔哩哔哩,...
揭秘关于!云扑克辅助软件(透视... 揭秘关于!云扑克辅助软件(透视)其实是真的有挂(详细教程)(有挂了解)-哔哩哔哩1、许多玩家不知道云...
我来教大家!鱼扑克有挂(辅助挂... 我来教大家!鱼扑克有挂(辅助挂)的确真的有挂(详细教程)(有挂介绍)-哔哩哔哩1、玩家可以在鱼扑克有...
重要通知!德州wpk辅助真的(... 重要通知!德州wpk辅助真的(透视)果真是真的有挂(详细教程)(有挂攻略)-哔哩哔哩是一款可以让一直...
终于懂了!pokerx智能软件... 终于懂了!pokerx智能软件(透视)果真真的有挂(详细教程)(有挂了解)-哔哩哔哩;(需添加指定薇...
玩家亲测!fishpoker俱... 玩家亲测!fishpoker俱乐部有挂(透视)果真真的有挂(详细教程)(有挂详情)-哔哩哔哩是一款可...
一分钟了解!德州ai辅助神器w... 一分钟了解!德州ai辅助神器wpk(辅助挂)确实真的有挂(详细教程)(有挂方法)-哔哩哔哩;德州ai...
终于懂了!德州全自动辅助(辅助... 相信很多朋友都在电脑上玩过德州全自动辅助吧,但是很多朋友都在抱怨用电脑玩起来不方便。为此小编给大家带...
透明讲解!德州全自动辅助(透视... 透明讲解!德州全自动辅助(透视)原来是真的有挂(详细教程)(有挂技巧)-哔哩哔哩相信很多朋友都在电脑...
玩家必备攻略!红龙扑克模拟器(... 玩家必备攻略!红龙扑克模拟器(辅助挂)的确是真的有挂(详细教程)(有挂总结)-哔哩哔哩1、让任何用户...