JavaScript is required
Back

函数中的动词选取

Mar 13, 2023

如何选好函数的动词,对于项目的可维护性有很重要的意义

创建/销毁

动词用途示例
Create创建实例,常用于实例化方法和工厂方法的命名CreateInstance
Initialize初始化实例的属性和设置,Initialize本身也可作为类方法用来初始化InitializeInstance,Initialize
Load加载配置,根据配置创建内容LoadFromConfig
Destroy销毁实例,常用语析构方法DestroyInstance
Uninitialize清理实例的属性和设置,通常和Initialize对应UninitializeInstance,Uninitialize

获取/设置

动词用途示例
Get常用于取属性的类方法命名,也可作为通用获取方法命名GetStartTime
Fetch通过网络请求获取内容FetchAllUsers
Calculate通过计算获取内容CalculateTotalAmount
Read读取(多用于文件,配置等)ReadFile,ReadConfig
Query查询QueryRemainingAmount
Find查找(多用于数据库,集合等),和 search 相似FindOrder
Receive接收(多用于文件,消息等)ReceiveNewMessage
Pull拉取PullLastestSourceCode
Set常用于设置属性的类方法命名,也可作为通用设置方法命名SetStartTime
Write写入(文件/配置等)WriteFile,WriteConfig
Put放入PutUserWithId
Push存入,推送(通知)PushNotification

更新

动词用途示例
Reset强调重置(标记,状态)ResetTimer
Refresh用于命名刷新(多用于页面,缓存等)RefreshCurrentPage
Update更新(多用于配置,状态等)UpdateUserSetting

添加/移除

动词用途示例
Add用于通用添加方法命名AddNewStudent
Append强调在尾部添加(追加)AppendCharacter
Insert强调插入(可以在任意位置)InsertCharacter
Delete表示删除,和 Remove 相近DeleteDirectory
Remove表示移除,和Delete相近RemoveInvalidDeals

启动/停止

动词用途示例
Open开启(多用于开启状态,打开文件等)OpenEnhanceMode
Start开始(强调开始某个流程)StartPortListening
Launch发动/启动(多用于启动程序,服务)LaunchAssistService
Close关闭(多用于关闭状态,关闭文件等)CloseEnhanceMode
Stop停止(强调流程的终止)StopPortListening
Pause暂停(强调流程的暂停,有可能后续会继续开启)PausePageLoading
Finish完成(强调流程的完成)FinishRequesting

集合类型相关数据处理

动词用途示例
Filter过滤,筛选(强调按照某些条件)FilterByName
Merge合并(有时会带上合并规则)MergeTwoConfig
Concat拼接(直接在结尾添加)ConcatToArray
Split分割SplitInput
Deduplicate去重(去重完全相同的项)DeduplicateList
Reverse颠倒,反向排列ReverseRecord
Sort排序(有时会带上排序规则)SortDealsByAmount
Fill填充(一般会进行覆盖)FillAmountList

通用业务数据处理

动词用途示例
Parse解析(解析成某些格式,解析提取某些内容)ParseFromJson,ParseResult
Analyse分析(不一定能通过简单的方式获取)AnalyseLocation
Convert类型转换(通常用于从一个类型转换到另一种类型)ConvertToString
Format格式化数据FormatToLocaleString
Validate合法性/有效性的校验ValidateUserInputs
Ensure期待值的校验EnsureUserAge
Compose组成(一般由多项内容组成一个结果)EnsureUserAge
Encode编码(依赖约定的编码格式)EncodeUrl
Decode解码(依赖约定的解码格式)EncodeUrl
Encrypt数据加密(依赖约定的加密算法)EncryptContent
Decrypt数据解密(依赖约定的解密算法)DecryptContent
Backup备份(需要注意拷贝方式,避免误导)BackupUserSettings
Restore恢复RestoreUserSettings
Import导入(通常用于按照特定格式的文件转换)ImportFromFile
Export导出(通常用于转换成特定格式的文件)ExportToFile
Compress压缩(依赖约定的算法)CompressOversizedFile
Decompress解压缩(依赖约定的算法)DecompressOversizedFile