方法命名规范

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

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

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