
课程咨询: 400-996-5531 / 投诉建议: 400-111-8989
认真做教育 专心促就业
编程规范是每一位软件编程开发程序员都需要遵守的,今天我们就通过案例分析来简单了解一下,程序员需要遵守哪些编程命名规范。
【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束
【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式也要避免采用。
【强制】类名使用UpperCamelCase风格,必须遵从驼峰形式,但以下情形例外:DO/BO/DTO/VO/AO
【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式。
【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。
【强制】抽象类命名使用Abstract或Base开头;异常类命名使用Exception结尾;测试类命名以它要测试的类的名称开始,以Test结尾。
【强制】中括号是数组类型的一部分,数组定义如下:String[]args;
【强制】POJO类中布尔类型的变量,都不要加is,否则部分框架解析会引起序列化错误。定义为基本数据类型BooleanisDeleted;的属性,它的方法也是isDeleted(),RPC框架在反向解析的时候,“以为”对应的属性名称是deleted,导致属性获取不到,进而抛出异常
【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
【强制】杜绝完全不规范的缩写,避免望文不知义。AbstractClass“缩写”命名成AbsClass;condition“缩写”命名成condi,此类随意缩写严重降低了代码的可阅读性。
【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词组合来表达其意。
【推荐】如果模块、接口、类、方法使用了设计模式,在命名时体现出具体模式。说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计理念。publicclassOrderFactory;
【推荐】接口类中的方法和属性不要加任何修饰符号(public也不要加),保持代码的简洁性,并加上有效的Javadoc注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是与接口方法相关,并且是整个应用的基础常量。接口方法签名:voidf();接口基础常量表示:StringCOMPANY="alibaba"说明:JDK8中接口允许有默认实现,那么这个default方法,是对所有实现类都有价值的默认实现。
【强制】对于Service和DAO类,基于SOA的理念,暴露出来的服务一定是接口,内部的实现类用Impl的后缀与接口区别。正例:CacheServiceImpl实现CacheService接口。
【推荐】如果是形容能力的接口名称,取对应的形容词做接口名(通常是–able的形式)。正例:AbstractTranslator实现Translatable。
【参考】枚举类名建议带上Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开。说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。
【参考】各层命名规约:Service/DAO层方法命名规约
【免责声明】:本内容转载于网络,转载目的在于传递信息。文章内容为作者个人意见,本平台对文中陈述、观点保持中立,不对所包含内容的准确性、可靠性与完整性提供形式地保证。请读者仅作参考。更多内容请加抖音太原达内IT培训学习了解。