较好的方法命名规则（转）

2015年11月19日 第一版

原文链接：http://qiita.com/KeithYokoma/items/2193cf79ba76563e3db6
原作者：KeithYokoma
译者：dssunxun

返回真伪值的方法

場所 单词 意义 例
Prefix is 对象是否是所期待的状态 isChecked
Prefix can 对象能否执行所期待的动作 canRemove
Prefix should 调用方执行某个命令好还是不好 shouldMigrate
Prefix has 对象是否持有所期待的数据和属性 hasObservers
Prefix needs 调用方是否需要执行某个命令 needsMigrate

按需求才执行的方法

場所 单词 意义 例
Suffix IfNeeded 需要的时候执行，不需要的时候什么都不做 drawIfNeeded
Prefix might 同上 mightCreate
Prefix try 尝试执行，失败时抛出异常或是返回errorcode tryCreate
Suffix OrDefault 尝试执行，失败时返回默认值 getOrDefault
Suffix OrElse 尝试执行、失败时返回实际参数中指定的值 getOrElse
Prefix force 强制尝试执行。error抛出异常或是返回值 forceCreate, forceStop

异步相关方法

場所 单词 意义 例
Prefix blocking 线程阻塞方法 blockingGetUser
Suffix InBackground 执行在后台的线程 doInBackground
Suffix Async 异步方法 sendAsync
Suffix Sync 对应已有异步方法的同步方法 sendSync
Prefix or Stem schedule Job和Task放入队列 schedule, scheduleJob
Prefix or Stem post 同上 postJob
Prefix or Stem execute 执行异步方法（注：我一般拿这个做同步方法名） execute, executeTask
Prefix or Stem start 同上 start, startJob
Prefix or Stem cancel 停止异步方法 cancel, cancelJob
Prefix or Stem stop 同上 stop, stopJob

回调方法

場所 单词 意义 例
Prefix on 事件发生时执行 onCompleted
Prefix before 事件发生前执行 beforeUpdate
Prefix pre 同上 preUpdate
Prefix will 同上 willUpdate
Prefix after 事件发生后执行 afterUpdate
Prefix post 同上 postUpdate
Prefix did 同上 didUpdate
Prefix should 确认事件是否可以发生时执行 shouldUpdate

与集合操作相关的方法

单词 意义 例
contains 是否持有与指定对象相同的对象 contains
add 添加 addJob
append 添加 appendJob
insert 插入到下标n insertJob
put 添加与key对应的元素 putJob
remove 移除元素 removeJob
enqueue 添加到队列的最末位 enqueueJob
dequeue 从队列中头部取出并移除 dequeueJob
push 添加到栈头 pushJob
pop 从栈头取出并移除 popJob
peek 从栈头取出但不移除 peekJob
find 寻找符合条件的某物 findById

与状态相关的方法

单词 意义 例
ensure 检查是否为期待的状态，不是则抛出异常或返回error code ensureCapacity
validate 检查是否为正确的状态，不是则抛出异常或返回error code validateInputs

操作对象生命周期的方法

单词 意义 例
initialize 初始化。也可作为延迟初始化使用 initialize
abandon 销毁的替代 abandon
destroy 同上 destroy
dispose 同上 dispose

与数据相关的方法

单词 意义 例
create 新创建 createAccount
new 新创建 newAccount
from 从既有的某物新建，或是从其他的数据新建 fromConfig
to 转换 toString
update 更新既有某物 updateAccount
load 读取 loadAccount
fetch 远程读取 fetchAccount
delete 删除 deleteAccount
remove 删除 removeAccount
save 保存 saveAccount
store 保存 storeAccount
commit 保存 commitChange
apply 保存或应用 applyChange
clear 清除数据或是恢复到初始状态 clearAll
reset 清除数据或是恢复到初始状态 resetAll

原文地址：https://www.cnblogs.com/sandea/p/9094863.html

时间： 2024-11-04 00:43:02

较好的方法命名规则（转）的相关文章

springDataJPQL实现增删改查及分页，原生sql查询，根据方法命名规则实现查询

一.使用方法 1.在dao中定义开一个方法,使用方法的参数设置jpql,并且使用方法的返回值接受查询结果,在方法上添加@query注解,在注解中写jpql语句进行增删改查,测试 2.使用原生的sql语句:dao中定义一个方法,在方法中添加@query注解,在注解中添加原生sql语句,并且添加一个属性:nativeQuery=true,测试 3.方法命名规则查询: 通过以肯定的规则,定义一个方法,框架本身就可以根据方法名生成一块个sql语句进行查询,规则: 1.必须以findBy开头 2.查询某个

21 方法命名规则查询

方法命名规则查询 顾名思义,方法命名规则查询就是根据方法的名字,就能创建查询.只需要按照Spring Data JPA提供的方法命名规则定义方法的名称,就可以完成查询工作.Spring Data JPA在程序执行的时候会根据方法名称进行解析,并自动生成查询语句进行查询 按照Spring Data JPA 定义的规则,查询方法以findBy开头,涉及条件查询时,条件的属性用条件关键字连接,要注意的是:条件属性首字母需大写.框架在进行方法名解析时,会先把方法名多余的前缀截取掉,然后对剩下部分进行解析

swift 初步接触 基本语法 方法命名 (一)

今天研究了一下swift语言,随便找了小demo,一点研究swift语法精髓,整体下来感觉很舒服,就是了解语法废了些时间,我感觉swift语言初期很难了解,不过理解过了之后,你才能真正的体会到这个语言的方便之处,没有过多的累赘,这个语言还真的是门不错的语言,废话不多说,记录下自己的理解笔记,如果有什么不对的大家多多指教....... 这个是UIViewController实现代码 //导入框架 import UIKit //文件的入口,也就是主要编辑程序的地方 class ViewControl

JavaWeb 命名规则

命名规范命名规范命名规范命名规范 本规范主要针对java开发制定的规范项目命名项目命名项目命名项目命名 项目创建,名称所有字母均小写,组合方式为:com.company.projectName.component.hiberarchy.1. projectName:项目名称2. component:模块名称3. hiberarchy:开发层次名称例如:com.company.tims.exchange.dao 类文件夹命名 ------------------------------------

java开发命名规则

1.文件 1.属性文件后缀为properties,并且符合java中i18n的规范:   2.对于各产品模块自己的配置文件必须放置在自己模块的conf目录下:   3.文件的命名需要有一定的意义,尽量简短,名称符合操作系统的要求且必须为英文或汉语拼音组成,文件名称不能存在空格,对于普通的文件单词与单词之间采用下 滑线进行. 2.命名规范   2.1基本规则 1.字符集在26个英文字母.0到9的阿拉伯数字和下划线之中.Java中类.字段.方法.变量.常量尽量用字母表达,没有特别的理由不能用任何的其

关于命名规则

骆驼式命名法(Camel-Case)一词来自 Perl 语言中普遍使用的大小写混合格式,而 Larry Wall 等人所著的畅销书<Programming Perl>(O'Reilly 出版)的封面图片正是一匹骆驼. 骆驼式命名法的命名规则可视为一种惯例,并无绝对与强制,为的是增加识别和可读性. 类名--大驼峰法 相比小驼峰法,大驼峰法(即帕斯卡命名法)把第一个单词的首字母也大写了.常用于类名,命名空间等.譬如 public class DataBaseUser; 函数名--小驼峰法(参考链接

变量的声明方法、原则和命名规则

变量的声明方法:1,先申明后赋值  int a; a=3; 2,定义变量是直接赋值  int a=3; 3,可以一次声明多个同类型变量,多外变量名称之间要用逗号隔开,最后以分号结束 int zsAge=18,lsAge=20,wwAge=30; 变量的声明原则:先声明----后赋值-----最后使用. 变量的命名规则:1,不能以数字开头  2,不能与C#中关键字重复  3,同一个变量名不能重复定义  4,大小写敏感 (camel命名法  首单词字母小写以后每一个单词首字母大写  英文单词缩写全部

get方法和set 方法的命名规则

@interface Time:NSObjct { int hour ; int minute; int second; } -(int) hour;//get 方法 :命名规则 返回类型就是成员变量的类型 方法就是成员的名字 -(void)setHour :(int )newHour://set方法 :命名规则 返回类型都是void 方法是set 加上成员变量名字的首字母大写 带一个参数 参数类型是成员变量的类型 实现部分 -(int)hour { return hour; } -(void)

变量,方法,类命名规则

命名规则:名称空间,类,基类中的成员 用 Pascal 形式 例如:MaxLength私有成员用 camel 例如 private int subscriberId成员字段常用一条下划线 例如: private int _subscriberId传递给方法的所有参数名称camel public void RecordSale(string SalesmanName)camel 大小写也用于区分2个对象 Pascal 规则每个单词开头的字母大写(如 TestCounter). Camel 规则除了