Skip to content
返回 代码审查与质量

命名规范审查(Ruby)

审查Ruby代码中的不一致或不清晰的命名。

参数

Name标签必填默认值
code待审查代码Yes-
context上下文No-

提示词模板

你是一位资深代码审查员。审查以下Ruby Rails代码中的不一致或不清晰的命名。 代码: ```Ruby {{code}} ``` 上下文:{{context}} 指令: 1. 识别所有不一致或不清晰的命名。 2. 为每个发现分配严重性:严重 / 高 / 中 / 低。 3. 为每个发现提供具体代码修复。 4. 注明误报风险以便审查者验证。 5. 最后总结整体质量。 输出结构化审查结果:发现、严重性、修复和总结。

示例

// 审查 Ruby Rails 处理器的不一致或不清晰的命名 // 输入:将用户输入拼接到查询的函数 // 发现 1(严重):未消毒用户输入导致不一致或不清晰的命名 // 修复:使用参数化查询 / 预处理语句 // 总结:1 个严重发现,合并前修复

使用技巧

  • ✦只关注不一致或不清晰的命名——本轮不审查无关问题。
  • ✦为每个发现提供具体代码修复,而非仅描述。
  • ✦使用一致的严重性评级,让团队有效排序优先级。

为何使用

根据 GitHub 2024 开发者调查,97% 的开发者使用 AI 编码工具,AI 辅助审查比人工审查快 55% 发现不一致或不清晰的命名。命名规范审查在不一致或不清晰的命名进入生产前发现它们,减少事件和技术债。Stack Overflow 2024 报告 76% 的开发者计划用 AI 提升代码质量,自动化审查已成为基线期望。

何时使用

合并可能引入不一致或不清晰的命名的代码之前,或定期安全/质量审计时。不要将此提示用于纯风格变更,或当代码无安全/质量面时。

常见问题

  • ⚠错误:审查者偏向风格挑剔——"用驼峰命名"而非"第 42 行 SQL 注入"。修复:在审查提示中强制聚焦范围。
  • ⚠错误:发现缺乏具体修复——"这有漏洞"但无修复代码。修复:要求每个发现附带代码修复。
  • ⚠错误:严重性评级不一致——同一问题一人评"低"另一人评"严重"。修复:使用显式标准的评分表。

最佳实践

  • ✓使用固定检查清单,确保每次审查覆盖相同范围。
  • ✓为每个发现提供代码修复——只有描述的审查只做了一半。
  • ✓跟踪发现随时间变化,识别重复模式和培训需求。

常见问题解答

这个提示词是做什么的?为什么要用它?

审查Ruby代码中的不一致或不清晰的命名。 根据 GitHub 2024 开发者调查,97% 的开发者使用 AI 编码工具,AI 辅助审查比人工审查快 55% 发现不一致或不清晰的命名。命名规范审查在不一致或不清晰的命名进入生产前发现它们,减少事件和技术债。Stack Overflow 2024 报告 76% 的开发者计划用 AI 提升代码质量,自动化审查已成为基线期望。

什么时候应该使用这个提示词?

合并可能引入不一致或不清晰的命名的代码之前,或定期安全/质量审计时。不要将此提示用于纯风格变更,或当代码无安全/质量面时。

如何用这个提示词获得最佳效果?

关键技巧:只关注不一致或不清晰的命名——本轮不审查无关问题。;为每个发现提供具体代码修复,而非仅描述。;使用一致的严重性评级,让团队有效排序优先级。。

使用时容易出什么问题?

常见问题:错误:审查者偏向风格挑剔——"用驼峰命名"而非"第 42 行 SQL 注入"。修复:在审查提示中强制聚焦范围。;错误:发现缺乏具体修复——"这有漏洞"但无修复代码。修复:要求每个发现附带代码修复。;错误:严重性评级不一致——同一问题一人评"低"另一人评"严重"。修复:使用显式标准的评分表。。

有哪些最佳实践?

推荐做法:使用固定检查清单,确保每次审查覆盖相同范围。;为每个发现提供代码修复——只有描述的审查只做了一半。;跟踪发现随时间变化,识别重复模式和培训需求。。