SuperAPI AI 工具集

cpp-api-documentation

编程与开发

查看项目

更新于 10-16 03:36

技能介绍

用途:该技能指导 AI 编码代理为 C++ 头文件添加 Doxygen 兼容的文档注释,仅用于补充或改进现有头文件中的 API 文档,不创建 Doxyfile、脚本、README 等新资源文件。

主要能力:覆盖文件、命名空间、类、函数/方法、成员变量、枚举、分组模块、继承与公式等文档模式。函数文档支持 @brief、@details、@tparam、@param(含 [in]、[out]、[in,out] 方向)、@return、@retval、@throws、@pre、@post、@note、@warning、@see、@deprecated、@todo 等标签,并规定标签顺序。公式支持 \f$..\f$、\f(..\f)、\f[..\f] 及 \f{environment}{..\f},可启用 USE_MATHJAX 或 FORMULA_MACROFILE。

使用方式:先识别头文件中未文档化或文档不足的公共 API,再按模板直接添加注释,最后审查准确性与可读性。文件头 @file 块应放在 include guard(#pragma once 或 #ifndef/#define)之后。风格采用 Javadoc 风格(@param、@return),单行用 ///,多行用 /** */,行宽建议 100 字符以内,使用现在时英文描述。

适用场景:为 C++ 头文件补充公共类、结构体、枚举、公共与受保护成员函数、模板参数、异常规范、线程安全与复杂度保证等文档。

限制:仅限头文件,不生成配置文件或脚本;私有实现细节可省略;资料未提供具体安装命令、收费或平台信息。