원클릭으로
ddev-comment-gen
C 项目注释生成与审查节点。在 ddev-c-pro 编码规范审查通过后,对 .c/.h 文件逐项检查注释完整性并补齐缺失注释。由 ddev-gate 调度,作为 c-pro 之后的独立审查步骤。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
메뉴
C 项目注释生成与审查节点。在 ddev-c-pro 编码规范审查通过后,对 .c/.h 文件逐项检查注释完整性并补齐缺失注释。由 ddev-gate 调度,作为 c-pro 之后的独立审查步骤。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
在当前会话里按已写好的实现计划顺序执行任务时使用
在已有规格或多步骤任务需求、且在动代码之前使用。若上游 ddev-pc-test 已产出测试用例,自动走 TDD 流程:先实现测试 demo 代码(红灯),再实现被测代码(绿灯),测试覆盖不到的部分直接开发。
文档审查技能。将文档审查任务派发给独立子代理,重点审查文档基于代码改动的合理性、说明正确性、前后一致性、错漏和逻辑谬误,以及 AI 实现过程中产生的决策记录(implementation-notes.md)。当用户需要审查技术文档、spec文档、设计文档、计划文档、API文档、README 或任何与代码改动相关的文档时使用。
代码修改场景下,spec 文档确认后,需要继续以图优先方式梳理结构体定义、数据流和流程时使用
在代码修改前需要编写 spec 文档且应优先用图表达边界、入口、流程和改动关系时使用(仅限代码改动场景,非项目级架构文档初始化)
在代码实现完成后、准备结束任务或进入发布前使用,用来核对代码实现是否与 spec 文档以及 detail 文档一致,并通过代码质量审查、清理、编码规范和注释审查后给出最终验收结论
| name | ddev-comment-gen |
| description | C 项目注释生成与审查节点。在 ddev-c-pro 编码规范审查通过后,对 .c/.h 文件逐项检查注释完整性并补齐缺失注释。由 ddev-gate 调度,作为 c-pro 之后的独立审查步骤。 |
在 ddev-c-pro 编码规范审查通过后,由 ddev-gate 拉起独立 subagent 加载本 skill,对代码注释做系统性审查和补全。
pass 后,ddev-gate 拉起.c / .h)pass(注释齐全)或 blocked(附缺失项清单 + 补全建议)审查 agent 必须逐文件、逐函数、逐结构体/枚举核验,不得仅凭印象判断。
.h 和 .c 文件必须包含 @file + @brief 头注释@brief 须说明本文件的主要职责,不能仅重复文件名/**
* @file module.h
* @brief 模块公开 API 定义,提供初始化和数据处理接口
*/
每个在 .h 中声明的公开函数必须包含完整 Doxygen 注释:
@brief:一句话说明函数做什么@param:每个参数一个,说明含义、约束(是否可为 NULL、取值范围)@return:返回值含义(无返回值写"无"或"void")@note / @warning / @see:按需添加/**
* @brief 模块初始化,分配并配置硬件资源。
* @param cfg 配置参数,不可为 NULL,baud 须 > 0。
* @return MODULE_OK (0) 成功,其他为错误码。
* @note 重复调用前须先 module_deinit。
*/
module_status_t module_init(const module_cfg_t *cfg);
struct / union 定义必须有 @brief 说明用途/**< 说明 */ 行内注释enum 必须有 @brief 说明枚举用途/**< 说明 */ 行内注释/** @brief 模块运行时上下文 */
typedef struct {
uint32_t baud; /**< 当前波特率 */
volatile bool running; /**< ISR 与主循环共享,仅原子读写 */
uint8_t rx_buf[256]; /**< 接收环形缓冲区 */
} module_t;
/** @brief 模块操作状态码 */
typedef enum {
MODULE_OK = 0, /**< 成功 */
MODULE_ERR_INVALID_ARG, /**< 参数非法 */
MODULE_ERR_TIMEOUT, /**< 操作超时 */
} module_status_t;
static 函数不强制 Doxygen 格式,但复杂逻辑必须说明意图static 函数建议添加简要块注释说明职责/** */ 或 ///)@brief / @param / @return / @note / @warning / @see / @todo / @retval.h 文件,逐一检查文件头、公开函数、结构体、枚举的注释完整性.c 文件,逐一检查文件头、私有函数的注释完整性pass;任一缺失 → blocked + 附缺失项清单ddev-comment-gen 审查结论:[pass | blocked]
若 blocked,清单:
- module.h:42 — module_init 缺少 @param cfg 注释
- module.c:10 — 缺少 @file 头注释
- module.h:25 — module_cfg_t 结构体缺少 @brief,成员 baud 缺少行内注释
- module.c:88 — ISR 回调缺少说明注释
当本 skill 被 ddev-gate 作为注释审查子代理加载时,必须使用 reviewer-prompt.md 作为任务模板执行审查。该模板定义了审查输入、审查维度优先级、CodeGraph 辅助查询方法和输出格式。
审查完成后将结果写入项目根目录的 progress.md: