較好的方法命名規則(轉)
阿新 • • 發佈:2018-05-27
bsp 事件 nta nds NPU remove change back syn
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 |
較好的方法命名規則(轉)