方法命名规范

心已赠人 2022-09-09 00:05 209阅读 0赞








































动词 含义 返回值
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 。

发表评论

表情:
评论列表 (有 0 条评论,209人围观)

还没有评论,来说两句吧...

相关阅读

    相关 命名规范

    项目中文件名字 1:符合应用场景 2:一律使用小写英文字母,统一要求;英文,禁止中文拼音。 5:命名原则:使团队成员可以看懂自己代码;自己也方便查找并修改 x

    相关 命名规范

    一、项目名 全部小写,比如cms、workdesk,jobserver等 二、java相关命名 a、类命名:每音节单词前的第一个字母大写,比如FieldInfo、Exp

    相关 Oracle命名规范

    1、编写目的   使用统一的命名和编码规范,使数据库命名及编码风格标准化,以便于阅读、理解和继承。   2、适用范围   本规范适用于公司范围内所有以[ORACLE][]

    相关 命名规范

    不能用什么命名? 1:不能中文命名 2:不能中英混合 3: 不能直接使用css属性明敏 4: 不能单独切直接使用html命名 命名规则- 驼峰式命名: