根本原因是doxyfile中input路径未正确指向源码目录或当前工作目录错误:input需为相对于doxyfile的路径(如src),不可用./src或绝对路径;多目录用空格分隔;file_patterns需包含.cpp等后缀;vscode终端pwd确认是否在项目根目录。

Doxygen 注释写完后,doxygen 命令不认路径或报错找不到输入文件
根本原因不是插件没装好,而是 Doxyfile 里配置的 INPUT 路径没指向真实源码目录,或者当前工作目录不对。VSCode 终端默认打开位置不一定是项目根目录,而 doxygen 是按相对路径解析 INPUT 的。
- 先在 VSCode 集成终端里执行
pwd,确认当前路径是含Doxyfile和源码的根目录 -
INPUT值必须是相对于Doxyfile所在位置的路径,比如源码在src/下,就写INPUT = src,别写./src或绝对路径 - 如果代码分散在多目录,用空格分隔:
INPUT = src include lib,不要用逗号 - 检查
FILE_PATTERNS是否包含你的文件后缀,C++ 项目默认不含.cpp,得手动加进去
用 TypeDoc 生成 TypeScript 项目文档时,typedoc 报 “No entry points found”
这个错误说明 typedoc 没扫描到任何可解析的 .ts 文件,常见于入口配置或编译上下文缺失。
-
entryPoints数组里的路径必须存在且是 .ts 文件(不是 .d.ts 或 .js),推荐用src/index.ts这类明确的入口,避免用src/**/* - 确保
tsconfig.json已存在,且typedoc能读取它;若项目用tsconfig.build.json,需显式传参:typedoc --tsconfig tsconfig.build.json - 如果用了
outDir输出 JS,typedoc默认只处理 TS 源码,不会去读编译后的 JS,所以别把entryPoints指向dist/ - 检查
exclude配置是否误删了关键目录,比如写了"**/src/**"反而排除了源码
OpenAPI 文档写好了,但 OpenAPI: Export as HTML 命令不可用或导出空白
该命令来自 OpenAPI (by Red Hat) 插件,但它只对合法 OpenAPI v3 YAML/JSON 文件生效,不是所有 .yaml 文件都能触发。
- 文件开头必须有
openapi: 3.0.3(或 3.1.0),写swagger: "2.0"不识别 - 右键菜单只有在当前编辑器聚焦该文件时才显示命令;如果文件标签没激活(比如后台打开),命令会灰掉
- 如果
paths下为空或全是注释,导出 HTML 会只有标题栏,没接口内容——插件不会报错,只会静默输出 - 导出前先看 Problems 面板:若有
$ref路径错误、缺失info字段等校验失败,命令仍能执行但结果不可靠
REST Client 的 .http 文件能当 API 文档用,但团队成员打开后格式乱、变量不生效
这不是渲染问题,而是环境配置没同步或语法细节被忽略。
-
rest-client.environment.json必须放在项目根目录,且文件名严格匹配(大小写敏感),VSCode 不会自动向上查找父目录 - 变量引用用双大括号:
{{apiUrl}},写成{apiUrl}或${apiUrl}都不生效 - 不同环境切换靠状态栏右下角的环境名称点击,不是靠修改 JSON 文件后自动重载——改完要手动点一次切换
- 注释行必须以
###或##开头才能被识别为分组标题,普通//或#不参与文档结构解析
大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!











