SuperAPI AI 工具集

clean-code

编程与开发

查看项目

更新于 10-16 08:05

技能介绍

用途:当用户要求清理代码、重构、提升可读性或进行可维护性代码评审时使用,帮助降低复杂度并改进命名。

主要能力: DRY(避免重复,单一事实来源);KISS(保持简单,避免过度设计);YAGNI(不做假设性的未来功能);命名规范(类用 PascalCase 名词、方法用 camelCase 动词、常量用 UPPER_SNAKE、包名小写、布尔量用 is/has/can/should 前缀);函数设计(保持函数小而专注、单一抽象层级、限制参数数量、用参数对象替代长参数列表、避免布尔标志参数、用卫语句替代深层嵌套);注释原则(解释“为什么”而非“什么”,避免噪音注释);常见代码异味(长方法、长参数列表、重复代码、死代码、魔法数字、上帝类、依恋情结、基本类型偏执)及对应重构手法(提取方法/类、引入参数对象、以多态替换条件、命名常量、卫语句等)。

使用方式:资料未提供具体安装命令或调用命令,仅说明在用户说出“clean this code”“refactor”“improve readability”等触发语或进行可维护性代码评审时启用。清洗时按上述原则检查:命名是否有意义、函数是否小且专注、是否存在重复代码、是否有魔法数字或字符串、注释是否解释“why”而非“what”、抽象层级是否一致、能否简化、是否有死代码或未使用代码。

适用场景:代码重构、代码评审、降低复杂度、改进命名、消除重复与嵌套等。

限制:资料未提供收费、价格、平台或效果信息;核心内容以 Java 示例为主,示例中提及相关技能 solid-principles、design-patterns、java-code-review,但未提供其安装或使用细节。DRY 存在例外,不宜过早抽象;部分重复代码可能因演化方向不同而保留。