
Codex 提示词怎么写清楚代码风格
我希望模型生成的代码更贴近团队习惯,但如果只说“写得规范一点”,结果通常不稳定。应该怎么描述代码风格,才能让 Codex 更准确地理解我的要求?
用可执行的风格规则来描述
不要只用“简洁”“优雅”这类抽象词,尽量把风格拆成可执行规则,例如:变量命名用驼峰还是下划线、函数保持多长、是否允许嵌套过深、注释写到什么粒度、是否偏向函数式或面向对象、异常处理采用什么模式。还可以直接给出一段符合要求的示例代码,让模型模仿其中的结构、命名和注释习惯。
团队里通常会有统一的代码规范,但我不确定要把哪些信息写进提示词里,才能让生成代码和现有项目风格一致。有哪些内容最值得明确说明?
优先说明团队最在意的几项规范
可以重点交代语言版本、格式化规则、命名约定、目录结构、函数拆分粒度、错误处理方式、日志风格和测试写法。如果项目里已经有 lint、formatter、框架约定或代码模板,也建议直接写进提示词。信息越接近项目真实约束,输出越容易融入现有代码库。
我能描述自己想要的感觉,比如“像资深工程师写的”“尽量容易维护”,但不会用专业术语说明。有没有更容易上手的表达方式?
用结果导向的表达方式补充细节
可以把目标拆成“看起来像什么”和“不能出现什么”。例如:代码要容易读懂、每个函数只做一件事、变量名要能直接看出用途、不要写过长的嵌套、尽量少用魔法数字、保留必要注释、避免过度抽象。这样即使不用专业术语,模型也能理解你对风格和可维护性的期待。
我发现只用文字描述时,生成的风格总有偏差。是不是应该直接给一段示例代码,让 Codex 按那个风格来写?
示例代码通常比抽象描述更稳定
如果你对风格有明确偏好,示例代码往往比长篇文字更有效,因为模型可以直接学习命名、排版、结构和注释方式。示例不需要很长,给出一段高质量的函数、类或模块片段就够了。再配合文字说明“保持同样的命名和拆分习惯”,生成结果通常会更接近预期。