代码整洁之道 (Clean Code) 本技能赋能 AI Agent 编写、审查和重构符合 Robert C. Martin (Uncle Bob) 《代码整洁之道》原则的代码。其核心目标是提高代码的可读性、可维护性和长期生产力。 核心原则 1. 有意义的命名 - 名副其实 :变量、函数或类的名称应说明其存在的意义、功能以及用法。 - 避免误导 :避免使用具有特定编程含义的词(如 除非它真的是 )。 - 做有意义的区分 :避免使用 , 或 这样模糊的命名。 - 使用读得出来的名称 :避免使用缩写(如 - )。 - 使用可搜索的名称 :单字母变量仅限用于短小的循环内部。 2. 函数 - 短小 :函数的第一条规则是短小。第二条规则是还要更短小。 - 只做一件事 :函数应该做一件事,做好这件事,且只做这一件事。 - 每个函数一个抽象层级 :确保函数内的语句都在同一抽象层级上。 - 函数参数 :最理想的参数数量是 0,其次是 1,再次是 2。尽量避免 3 个及以上参数。 - 无副作用 :函数不应在暗地里修改全局变量或对象状态。 - 分隔指令与询问 :函数要么执行某项动作,要么回答某个问题,不应兼而有之。 3. 注释 - 注释不能美化糟糕的代码 :代码应当能自解释。如果需要注释,首先考虑是否可以通过重构来消除注释。 - 好的注释 :法律信息、对意图的解释、警示后果、TODO 注释。 - 糟…