方法命名规范

方法命名规范动词 含义 返回值 can 判断是否可执行某个动作(权限) 函数返回一个布尔值。true:可执行;false:不可执行 has 判断是否含有某个值 函数返回一个布尔值。true:含有此值;false:不含有此值 is 判断是否为某个值 函数返回一个布尔值。true:为某个值;false:不为某个值 get 获取某个值 函数返回一个非布尔值 set 设置某个值 无返回值、返回是否设置成功或者返回链式对象 load.

大家好,欢迎来到IT知识分享网。方法命名规范

动词 含义 返回值
can 判断是否可执行某个动作(权限) 函数返回一个布尔值。true:可执行;false:不可执行
has 判断是否含有某个值 函数返回一个布尔值。true:含有此值;false:不含有此值 
is 判断是否为某个值 函数返回一个布尔值。true:为某个值;false:不为某个值
get 获取某个值 函数返回一个非布尔值
set 设置某个值 无返回值、返回是否设置成功或者返回链式对象
load 加载某些数据 无返回值或者返回是否加载完成的结果

1 ) 获取单个对象的方法用 get 做前缀。

2 ) 获取多个对象的方法用 list 做前缀。

3 ) 获取统计值的方法用 count 做前缀。

4 ) 插入的方法用 save/insert 做前缀。

5 ) 删除的方法用 remove/delete 做前缀。

6 ) 修改的方法用 update 做前缀。

函数和方法的命名应该以动词开始,使用Pascal大写。不要使用带下划线的字符。
例如:InitNameArray,CloseDialog

【规范】类名使用
 UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例外: ( 领域模型的相关命名 )DO / BO / DTO / VO 等。

 正例: MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion

 反例: macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

 

 【规范】方法名、参数名、成员变量、局部变量都统一使用
 lowerCamelCase 风格,必须遵从驼峰形式。

 正例: localValue / getHttpMessage() / inputUserId
 

 【规范】
 常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。

 

 【规范】抽象类命名使用 Abstract 或 Base 开头 ; 异常类命名使用 Exception 结尾 ; 测试类命名以它要测试的类的名称开始,以 Test 结尾。枚举类名建议带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。

 

 【规范】POJO 类中布尔类型的变量,都不要加 is ,否则部分框架解析会引起序列化错误。
 

 【规范】各层命名规约:

 A) Service / DAO 层方法命名规约

 1 ) 获取单个对象的方法用 get 做前缀。

 2 ) 获取多个对象的方法用 list 做前缀(习惯:getXXXList)。

 3 ) 获取统计值的方法用 count 做前缀。

 4 ) 插入的方法用 save( 推荐 ) 或 insert 做前缀。

 5 ) 删除的方法用 remove( 推荐 ) 或 delete 做前缀。

 6 ) 修改的方法用 update 做前缀(或modify)。

 B) 领域模型命名规约

 1 ) 数据对象: xxxDO , xxx 即为数据表名。

 2 ) 数据传输对象: xxxDTO , xxx 为业务领域相关的名称。

 3 ) 展示对象: xxxVO , xxx 一般为网页名称。

 4 ) POJO 是 DO / DTO / BO / VO 的统称,禁止命名成 xxxPOJO 。

免责声明:本站所有文章内容,图片,视频等均是来源于用户投稿和互联网及文摘转载整编而成,不代表本站观点,不承担相关法律责任。其著作权各归其原作者或其出版社所有。如发现本站有涉嫌抄袭侵权/违法违规的内容,侵犯到您的权益,请在线联系站长,一经查实,本站将立刻删除。 本文来自网络,若有侵权,请联系删除,如若转载,请注明出处:https://yundeesoft.com/20705.html

(0)

相关推荐

发表回复

您的电子邮箱地址不会被公开。 必填项已用 * 标注

关注微信