apidoc是一个生成API文档的工具,可以通过注释来生成API文档。默认情况下,apidoc会排除掉注释中以@开头的特殊注释,例如@ignore和@exclude。
如果你想要使用apidoc的排除模式,但又不想排除掉特殊注释,可以按照以下步骤修改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文档中。