clean-code

Clean Code - AI 整洁代码规范助手

技能概述

Clean Code 是一个 CRITICAL 级别的 AI 编程技能，通过 SRP、DRY、KISS、YAGNI 等实用原则，帮助您自动检查代码质量、规范命名、简化函数设计，让代码更易维护。

适用场景

1. Pull Request 代码审查

在提交 PR 前让 AI 自动检查代码是否符合整洁代码规范，包括命名是否清晰、函数是否过于复杂、是否存在重复代码等常见问题，减少人工审查工作量。

2. 代码重构与优化

当现有代码变得难以维护时，使用 Clean Code 技能识别过度工程化的部分、提取重复逻辑、应用卫语句简化嵌套，让代码回归简洁清晰。

3. 新功能开发规范检查

编写新功能时，让 AI 实时提醒是否违反单一职责原则、函数参数是否过多、是否创建了不必要的辅助文件，从源头保持代码质量。

核心功能

1. 智能代码规范检查

基于 SRP、DRY、KISS、YAGNI、Boy Scout 等五大核心原则，自动分析代码是否存在职责混乱、重复逻辑、过度设计等问题，并给出具体修改建议。

2. 命名与函数规范

检查变量名、函数名、布尔值、常量是否符合规范（如 getUserById() 而非 user()，hasPermission 而非 permission），确保代码自文档化，无需额外注释即可理解。

3. 结构优化建议

识别深层次嵌套、过长函数、多余文件等反模式，推荐使用卫语句、函数组合、就近放置等模式简化结构，让代码保持扁平化和可读性。

常见问题

Clean Code 技能是什么？能做什么？

Clean Code 是一个 AI 编程助手技能，专注于帮助开发者编写更整洁、更易维护的代码。它可以检查代码是否符合 SRP（单一职责）、DRY（不重复）、KISS（保持简单）等原则，识别命名不规范、函数过长、过度工程化等问题，并给出具体的改进建议。与其他代码检查工具不同，Clean Code 更关注代码的可读性和长期可维护性。

如何使用 Clean Code 技能进行代码审查？

在您的代码库中启用 Clean Code 技能后，AI 会在编写代码时自动应用整洁代码原则。当您提交代码或请求审查时，技能会检查：函数是否超过 20 行、是否存在重复逻辑、命名是否清晰表达意图、是否创建了不必要的辅助文件等。审查结果会以清晰的格式展示问题位置和修改建议，您可以确认后让 AI 自动修复。

Clean Code 的核心原则有哪些？

Clean Code 基于五大经典原则：SRP（单一职责）要求每个函数/类只做一件事；DRY（不重复自己）要求提取重复代码复用；KISS（保持简单）要求用最简单的方案解决问题；YAGNI（你不需要它）提醒不要为未来可能不需要的功能写代码；Boy Scout（童子军规则）要求每次修改代码时都要让它比之前更整洁。