先删掉“本函数”“该方法”这类书面套话
在夸克AI对话框中输入指令时,明确要求“请用口语化中文书写注释,避免使用‘本函数’‘该方法’‘此参数’等书面术语”。【这是影响注释自然度的关键雷区,不删除这类表达,AI会默认按照教科书风格输出】
比如,AI可能会输出:“本函数用于对用户上传的头像图像进行中心裁剪。”而优化后则是:“把用户头像从中间切一刀,留下正方形那块。”哪个更易于理解一目了然。
用“你”“我”“咱们”代入角色
方法一:在提示词起始加入“你是一位拥有五年经验的前端专家,正在向新同事口头解释这段代码逻辑”。
方法二:明确指出“注释中使用‘你’代表调用方,‘我’代表当前函数,例如‘你传入一个ID,我来查找对应的用户’”。
这样能迅速激发AI的对话感。将“调用方传入参数”替换为“你把手机号给我,我帮你检查是否已注册”,读起来就像同事之间的现场交流。
把技术动作转成生活动词
第一步:从代码中提取所有技术动词,例如“校验”“解析”“映射”“触发”等。
第二步:将其逐一替换为日常用语——“校验”变成“检查一下”,“解析”变成“拆解内容”,“映射”变成“对应匹配”,“触发”变成“执行调用”。
第三步:在提示词中明确说明:“注释中所有技术动词须替换为生活化表达,例如‘校验’用‘检查一下’代替,‘解析’用‘拆解内容’代替”。
注意:不要依赖AI自行替换,这样容易出错。你需要提供清晰的对照表,例如指定“幂等”应改为“重复操作结果相同”,避免AI产生误解。
加一句真实场景限制
在提示词结尾添加:“注释字数控制在20字以内,并且读起来必须顺畅——自己朗读一遍,如果出现换气困难,就重新调整”。
这条看似简单,却能有效避免AI生成嵌套从句和长定语。例如,不会出现“当用户在未登录状态下且网络请求超时后重试次数已达上限时……”,而是简化为“未登录?网络超时?尝试三次后放弃”。
