给函数取一个好的名字
最近看到比较有趣的文章,记录一下重点内容
转载自https://www.cnblogs.com/dolphin0520/p/10567879.html
函数命名最佳实践
要领1:动词选取要精准
通常来说,动词决定了一个函数要采取什么”动作”。动词取的好,一个函数名字已经成功了80%。
动词决定了函数的具体动作,而名词决定了函数具体的操作对象,对于名词,尽量使用领域词汇,不要使用生僻或者大家很少使用的词语。
常用动词表:
类别 单词 添加/插入/创建/初始化/加载 add、append、insert、create、initialize、load 删除/销毁 delete、remove、destroy、drop 打开/开始/启动 open、start 关闭/停止 close、stop 获取/读取/查找/查询 get、fetch、acquire、read、search、find、query 设置/重置/放入/写入/释放/刷新 set、reset、put、write、release、refresh 发送/推送 send、push 接收/拉取 receive、pull 提交/撤销/取消 submit、cancel 收集/采集/选取/选择 collect、pick、select 提取/解析 sub、extract、parse 编码/解码 encode、decode 填充/打包/压缩 fill、pack、compress 清空/拆包/解压 flush、clear、unpack、decompress 增加/减少 increase、decrease、reduce 分隔/拼接 split、join、concat 过滤/校验/检测 filter、valid、check 要领2:名词使用领域词汇
举个例子:集合的容量通常用capacity、集合实际元素个数用size、字符串长度用length,这种就遵循大家的使用习惯,不要用size去形如字符串的长度。
再比如,假如使用到建造者模式,那么通常会用build作为函数名字,这个时候就不要另辟蹊径,用create来作为函数名字,使用大家约定俗成的命名习惯更容易让你的代码被别人读懂。
常用名词表:
类别 单词 容量/大小/长度 capacity、size、length 实例/上下文 instance、context 配置 config、settings 头部/前面/前一个/第一个 header、front、previous、first 尾部/后面/后一个/最后一个 tail、back、next、last 区间/区域/某一部分/范围/规模 range、interval、region、area、section、scope、scale 缓存/缓冲/会话 cache、buffer、session 本地/局部/全局 local、global 成员/元素 member、element 菜单/列表 menu、list 源/目标 source、destination、target
本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来自 食葫芦的葫芦娃!
评论