Skip to content

Latest commit

 

History

History
69 lines (63 loc) · 3.97 KB

File metadata and controls

69 lines (63 loc) · 3.97 KB

Code Style

  • 变量命名遵循 lowerCamelCase,类名使用 PascalCase,保持与现有源码一致。
  • 缩进统一使用四个空格,不使用制表符。
  • 函数定义的开括号另起一行,控制语句的开括号与语句同行。
  • 头文件按照模块分组,并以空行分隔。
  • QML 文件同样使用四空格缩进,属性命名采用 lowerCamelCase。
  • include 语句按 // Qt lib import// XXX import等分组,并以空行分隔。
  • 头文件使用 #ifndef MODULE_H_ 风格的宏作为 include guard,不使用 #pragma once,没有在 #endif 与注释之间留空格。
  • 控制语句与表达式中,运算符两侧以及括号前后需留空格。
  • 私有成员变量不添加 m_ 前缀,保持与现有源码一致,在变量后增加_
  • 局部变量常使用 autoconst auto 进行类型推导。
  • 静态常量和全局常量名称保持 lowerCamelCase。
  • 注释多采用 // 行注释,优先使用简体中文说明。
  • 当函数参数较多时,换行后每个参数独占一行并在行末加逗号。
  • 单行的内联函数通常写在 .inc 文件中,花括号独立成行。
  • switch 语句中的简单 case 常将花括号与 case 同行并在其中完成逻辑。
  • QML 组件的 id、属性与信号处理函数均使用 lowerCamelCase,属性赋值的冒号后紧跟一个空格。
  • QML 中的用户可见字符串需使用 qsTr("%Key%") 包裹,以便翻译。

Build

  • 不执行构建测试,因为环境比较特殊,无法部署到容器内。
  • 不要在容器内编译代码,如果有必要只进行静态检查。

Testing

  • 不运行编译,只做静态检查。
  • 不运行测试用例,因为环境比较特殊,无法部署到容器内。

文件编码

  • 忽略文件编码有关的错误或警告。
  • 忽略文件的BOM头有关的错误或警告。
  • 文件默认用UTF8或者UTF-BOM格式打开和编辑。

过滤文件

  • 在所有处理中,都忽略*.tmp文件和*.user文件
  • 忽略build目录

LLM

  • 默认使用简体中文:除非用户明确要求其他语言或上下文中使用英文,否则所有对话、解释、示例以及代码注释均应使用简体中文。
  • 系统提示 (system prompt):在调用 LLM(如 OpenAI Codex)时,请在 system 级别的 prompt 中显式加入 请使用简体中文回答 或等效中文指令,保证模型优先选择中文回复。
  • 前缀提示 (user prompt):如需进一步加强,可在每条用户 prompt 前添加 请用简体中文回答以下内容: 作为前缀提示,使模型在对话层面持续保持中文上下文。
  • 语言切换规则:若用户以英文提问或明确要求英文/其他语言,可切换对应语言;否则保持使用简体中文。
  • 专业术语:遇到必须保留的英文专业术语时,可直接使用英文,并在括号中补充简要中文解释。
  • 示例驱动:在 few‑shot 示例中,优先提供中文问答示例,以强化中文输出的先验概率。

CodeX

你运行在 Windows 10 + VSCode,集成终端是 Windows PowerShell 5.1。 生成命令必须遵守: 1)基础规则

  • 使用 PowerShell 语法,不使用 bash 语法。
  • 不要输出以 "$ " 开头的提示符。
  • 不要套用 powershell.exe -Command,只输出要执行的命令本身。
  • 不使用 "&&" 或 "||",用 ";" 或多行代替。 2)目录与路径
  • 切换目录:Set-Location 'e:\Repositories\XXX' 或 cd 'e:\Repositories\XXX'
  • 路径建议用单引号包裹。 3)ripgrep (rg)
  • 写法示例: Set-Location 'e:\ABC\maintainer'; rg 'pattern' maintainer tools
  • 正则可用 '|'。
  • rg 退出码说明:
    • 0 = 有匹配(成功)
    • 1 = 无匹配(正常,不算错误)
    • 2+ = 真正的错误
  • 不要在外层再封装:'powershell.exe' -Command '...rg...' 4)文件写入
  • 不要自动生成 Set-Content、Out-File、">"。
  • 禁止 Set-Content -Path $null 或任何空路径写法。
  • 只有我明确要求写文件且提供路径时才可生成写文件指令。