最近在读《代码整洁之道》这本书,还是收益匪浅的。现在看了十章,感觉收获颇丰。在此总结记录一下,也是提醒自己要注意平时的代码规范。
1、命名整洁无歧义。此处包括类名、方法名、变量名等等名称。不怕会用很长时间起名字,一个好名字往往可以事倍功半。不管是在阅读自己代码或者别人代码,如果见名知意,那是比写多少行注释有用的多。(最近刚改完别人的代码,此处感受颇深)
2、常量名最好定义长串名称大写,方便搜索,同时避免魔术数字。如果a=4的话,想要改变此处全局搜索可能会搜索出很多a,如果定义的是个MINSTOCK=4 可能会更好检索。
3、抽象类接口不加无用字符(此处个人觉得重点是大家能懂,如果有不成文的规定,那么就随众吧)
4、类名多用名词,方法名多用动宾搭配,而且尽量少用get开头。此处是因为对实体进行get\set方法较多的时候,使用快捷键提示get会出现很多,不方便查找。另方法参数不传null值,参数不返回null值,这样可以避免些空指针(个人目前应用的时候觉得null很方便,还需在实践中摸索)
6、避免魔术数字,可以抽取方法或者实体类搭配
7、寓意较多的词可以用加前后缀区分,比如status,在一个实体中可能有多种状态
8、错误处理:用异常代替状态码,捕获多种异常返回自定义异常,可以快速知晓异常类型,不用用拿到的结果进行各种if…else..判断状态码。
未完待续。。。