apidoc不排除排除模式
创始人
2024-09-07 12:31: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文档中。

相关内容

热门资讯

安装apache-beam==... 出现此错误可能是因为用户的Python版本太低,而apache-beam==2.34.0需要更高的P...
避免在粘贴双引号时向VS 20... 在粘贴双引号时向VS 2022添加反斜杠的问题通常是由于编辑器的自动转义功能引起的。为了避免这个问题...
Android Recycle... 要在Android RecyclerView中实现滑动卡片效果,可以按照以下步骤进行操作:首先,在项...
omi系统和安卓系统哪个好,揭... OMI系统和安卓系统哪个好?这个问题就像是在问“苹果和橘子哪个更甜”,每个人都有自己的答案。今天,我...
原生ios和安卓系统,原生对比... 亲爱的读者们,你是否曾好奇过,为什么你的iPhone和安卓手机在操作体验上有着天壤之别?今天,就让我...
Android - 无法确定任... 这个错误通常发生在Android项目中,表示编译Debug版本的Java代码时出现了依赖关系问题。下...
Android - NDK 预... 在Android NDK的构建过程中,LOCAL_SRC_FILES只能包含一个项目。如果需要在ND...
Akka生成Actor问题 在Akka框架中,可以使用ActorSystem对象生成Actor。但是,当我们在Actor类中尝试...
Agora-RTC-React... 出现这个错误原因是因为在 React 组件中使用,import AgoraRTC from “ago...
Alertmanager在pr... 首先,在Prometheus配置文件中,确保Alertmanager URL已正确配置。例如:ale...