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

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...