返回博客
TIPS
["DeepCode"
"代码风格"
"技巧"]

让 DeepCode 写出“像我们组”的代码,我靠这三条约定

平台管理员
2026年5月13日
17 次阅读

我让 DeepCode 写过一段数据读取脚本。功能没问题,跑通了。但合进仓库时我皱了眉头:函数命名是小驼峰,注释是中文,路径还是字符串拼接——和我们组其它文件像是两个世界的东西。改格式比重写还累。

后来我发现,问题不在 AI,在我没先给它看“家规”。

把风格约定 upfront 告诉 AI,能省下大量返工时间。
把风格约定 upfront 告诉 AI,能省下大量返工时间。

先提炼三条真实约定

别写长篇风格指南。打开你最近写得最顺手的三个文件,挑三个共同点:函数名用 snake_case、注释用英文、路径用 pathlib。写成一段“风格说明”,每次生成代码时贴进去。我观察到别人常犯的错误是,规则列了十几条,AI 根本记不住,输出反而更乱。

再丢一段你认可的代码

抽象描述不如直接示例。把组里一个写得好的函数贴给 DeepCode,说“请按这种风格写”。它会模仿命名密度、注释习惯和异常处理方式。如果是材料计算脚本,同时给一段现有后处理代码和一段模拟输入示例,效果更明显。

第三步:把规则沉淀成可复用模板

建一个 code-style.txt,存三条常用规则。每次调用 DeepCode 直接引用。我的判断是:风格一致不是为了好看,而是为了三个月后回看代码时,不用重新理解一套新逻辑。

  • 所有函数必须有 docstring,说明参数类型和返回类型。
  • 文件路径统一用 pathlib.Path
  • 避免使用全局变量,数据通过函数参数传递。
风格一致不是为了好看,而是为了三个月后你自己回看代码时,不用重新理解一套新逻辑。

AI 生成的代码别直接合并。先跑测试,再扫一眼命名和注释。这个习惯能帮你避开很多低级坑。

评论 (0)

登录 后才能发表评论