模板注释不参与API文档生成,仅作团队协作说明或临时标记;真正起作用的是控制器方法上方符合OpenAPI规范的@OA\Xxx注解。

ThinkPHP 模板注释本身不参与 API 文档生成,它和接口文档毫无关系。模板里的 <!-- 注释 --> 或 {// 注释} 是给前端开发或页面维护看的,运行时被忽略,也不会被任何文档工具扫描、解析或提取。
真正起作用的是控制器方法上方的 PHPDoc 注释块,且必须是符合 OpenAPI 规范的 @OA\Xxx 注解(如 @OA\Get、@OA\Parameter),不是普通 @param 或 @return。
那模板注释能“辅助”什么?只有两种间接、边缘但实际存在的场景:
团队协作时标注接口用途
比如在某个.html模板里写:<!-- 调用 /api/v1/orders 接口,用于渲染订单列表,需传 page=1&limit=10 -->
这类说明不进文档,但能帮前端快速定位后端接口,减少沟通成本。临时标记待文档化接口
开发过程中,可在模板中加醒目标记:<!-- TODO: @OA\Get(path="/api/v1/report") 尚未补全注解,请同步更新 swagger.json -->
作为任务提醒,避免遗漏文档补充。
注意:这类写法纯属人工约定,没有任何工具会读取、校验或联动。一旦依赖它做文档管理,很容易过期失效。
立即学习“PHP免费学习笔记(深入)”;
所以核心还是回到控制器层——
- 注释必须紧贴
public function xxx()上方 - 用
@OA\Get等完整命名空间注解 -
path值必须和路由注册的 URL 完全一致(含/api/前缀) - 参数、响应结构必须显式声明,不能靠函数签名推测
模板注释顶多是个便利便签,别把它当文档基础设施。



















