用途:这是一份代码审查质量检查清单,供提交代码前和代码审查过程中使用,帮助审查者按统一标准逐项核对。
主要能力:清单分为六部分。一是项目模式,检查图标是否通过 core::ArtProvider::getInstance().getIcon() 获取、QActions 是否通过 createAction() 创建、是否避免硬编码路径 QIcon("path/...");UI 字符串是否全部经 tr()、是否无硬编码字符串;配置是否经 core::SettingsManager::getInstance()、是否无硬编码配置值;颜色是否经 getPrimaryColor() 或 ThemeManager 获取、是否无硬编码 QColor(r, g, b);日志是否使用 core::Logger::getInstance().info/debug/error() 且级别合适。二是代码质量,涉及命名规范(文件 snake_case.cpp、类 PascalCase、方法 camelCase、成员 m_camelCase、常量 UPPER_SNAKE_CASE)、注释(公共方法用 /// 写 Doxygen、无注释掉的代码、新代码无 TODO/FIXME)、代码风格(无未使用导入/包含、无未使用变量、缩进一致)。三是文档,包括 CHANGELOG.md 的 [Unreleased] 条目与分类、ROADMAP.md 的复选框与任务编号、计划/规格与状态更新。四是构建与测试,构建需通过 scripts/build_windows.bat Debug 且无新警告,测试需既有测试通过、新功能补充新测试。五是审查决定,全部勾选且无严重问题则批准;缺少 tr()、硬编码图标/颜色、缺少 CHANGELOG 条目、构建或测试失败则要求修改;安全问题、未讨论的破坏性变更、重大架构违规则阻止。六是输出格式,返回 decision(approve/request_changes/block)、summary 和 issues 列表。
使用方式:在提交前或审查时逐项核对上述条目,并按指定 JSON 结构输出结论。
适用场景:采用该核心模块与命名约定的项目中的代码审查与提交前自检。
限制:清单内容针对特定项目结构与 API,其他项目需调整;资料未提供安装命令、收费或平台信息。