------Java培训、Android培训、iOS培训、.Net培训</a>、期待与您交流! -------
问题背景
有人把编程称为艺术,把程序当做艺术品来对待。两者确实有很多相似之处,都是一种创造性的活动,都需要付出大量脑力劳动,都需要一丝不苟,认真对待。 但编程毕竟是一种技术,更注重功能实现,注重开发效率,注重正确性,可靠性和性能。至于看起来是不是那么赏心悦目,似乎就显得不是那么重要了。
在我们的编程规范中有命名规范要求的章节,提出了很多命名的建议和方法。只是,我们在开发中,更多的关注了软件运行的正确性,而忽视了代码的可读性和可维护性。这样的后果,就是会造成不必要的开销,效率降低,甚至引发现网事故。
字段命名
变量,类成员,数据库字段的命名和常量类似,需要说明字段的含义或用途。
一些个人建议:
1. boolean类型的字段,根据名字就可以区分“true”和“false”分表代表的含义
2. 枚举类型的字段不要使用“is”这样的命名前缀
3. 使用足够的限定语,说明字段的准确含义
方法命名
对于方法命名,普遍的建议是使用 “动词” 或 “动词 + 名词”。
是否符合自然语言习惯是判断代码可读性的一条简单标准。
不过,这里的语言习惯更多的是英文的语言习惯,而不是中文的语法规则。
一些方法命名的建议:
1. 根据方法名可以知道方法的功能和作用,包含:动作,操作对象类型,约束条件
2. 根据方法名可以知道方法是否进行了数据修改,is,check 前缀的方法不应该对业务数据进行修改,不对数据进行修改的方法,最好在命名上能够体现
3. 在特定的代码层次,以及业务场景下,使用约定的动词,譬如:is,check,exists,get,search,update,save,delete,prepare,do,exec 等等