《代码整洁之道》读书笔记 |
您所在的位置:网站首页 › abort词组 › 《代码整洁之道》读书笔记 |
1,命名的范围 变量、函数、参数、类、封包、代码文件、目录等。 2,选个好名字要花时间,但省下来的时间比花掉的多。 3,如果名称需要注释来补充,那就不算是名副其实。 这点在中国来说,可能有时候,真需要写注释,因为很多人单词量达不到。 4,改名与逻辑封装的例子 补图 5,不要用约定俗成的名来命名不一样含义的变量 如:圆周率Pi 6,命名中带类型的词要与其类型贴合 如:accountList,应该是个集合 7,避免长名称只有小不同 如:XYZControllerForEfficientHandlingOfStrings和XYZControllerForEfficientStorageOfStrings; 8,避免使用拼写误导的字母 如:1和l;0和O; 9,避免以错误的拼写充数,导致纠正后反而出错 如:class->klass; 10,避免使用数字序列 如:a1,a2等 11,不要有多余的废话 如:Product,非要写成ProductInfo或者ProductData; 如:Vriable不应该出现在变量中,Table不应该出现在表名中 12,不要自造词 如:WorkBreakDown写成wkbkdown; 13,单词的名称要容易被搜索出来; 因为有时候会针对某个关键字,进行整个项目的搜索,如果写成e或a,将会搜出一大堆不具参考价值的结果; 14,名称长短应与其作用域大小相对应; 15,避免使用编码 如:intAge,strName或 addrString 16,成员变量无需增加m_多余的前缀; 前缀已成为旧代码的标志物。 17,接口不要带I前缀,宁愿实现类增加Imp后缀; 18,避免思维映射; 如:i、j、k用于循环计数器,l用于长度变量,避免使用l当作循环计数器; 19,专业程序员应该知道:明确是王道; 20,类名 使用名词或名词短语; 如:Product; 21,方法名 使用动词或动词短语; 如:deleteItem,save; 22,不要写俗语或俚语 如:Whack(劈砍)代替 kill;eatMyShorts(去死吧)代替 abort; 这个国人应该会出现的少; 23,避免同一单词用于不同的目的 如:add,如果放到StringBuilder中,应该用append; 24,多用技术性名称 如:JobQueue 工作队列 25,如涉及问题领域,则使用其专业名称来命名; 26,添加有意义的语境 很少有名称能自我说明,它需要有良好的类、函数或名称空间来提供语境。 如:state,当它放在类 Work中时,可以说明工作的状态; 如果实在没没有,则给它加前缀。 如:state 加前缀 workState; 27,函数要尽量分解的小; 28,不要添加没用的语境 如:“加油站豪华版(Gas Station Deluxe)”的应用,给每个类都加上了GSD,就多余; 29,只要短名称足够清楚,就要比长名称好。 |
今日新闻 |
推荐新闻 |
CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3 |