代码书写规范好像是个小问题,但也是很多新手经常会犯错。有时候我们知道该怎么做,挺难坚持的,今天公司的技术总监看完代码后,和我聊聊了代码的优雅和可读性。觉得有所收获,一边总结一边分享,让我们的代码越来越优雅和美观。
1 命名:一般使用驼峰命名的方式,不使用没有任何意义的英语字母命名,不使用汉语拼音命名,使用准确的英文命名,看看老外的源码就能感受到那种优雅。对于名词,必须使用单数,对于数据,必须使用复数,而且翻译必须准确。对于布尔类型变量,不建议使用is***的方式,也建议使用形容词。JavaBean生成的get和set方法很符合英文阅读习惯。对于方法名的命名,使用“动宾结构短语或者“使动词+表语结构”,如果宾语是对象集合,使用复数最好。还有,宁可方法名字长点,也别让人看不懂。注意成员变量不要覆用类名。最后在啰嗦一句,命名要从业务角度出发比从技术角度出发好点。
2 空格 代码中合理的空格会让代码的逻辑更清晰,结构更优雅。根据逻辑或业务处理需要,适当的留出空白,会让代码错落有致,看起来更优雅。
3注释 类注释,必须有。方法的注释,如果是系统级别的,可以没有注释,但是自己定义,必须给出注释。方法中关键的逻辑处理或业务处理,也得添加注释。
4代码简洁 只有简洁高效的代码才算的上优雅,这个需要不断的积累,才可厚积薄发。想到两个好方法,第一,阅读优质源码 第二 ,重构自己的代码 然后就是多总结和反思。
入职两个月,也就这么多,总结的同时拿出来和大家一起分享。特别感谢公司技术总监指导,也希望大家能共同进步,成为自己心中最优雅的程序员。