工程实践:给函数取一个好的名字
https://www.cnblogs.com/dolphin0520/p/10567879.html
工程实践:给函数取一个"好"的名字
早在2013年,国外有个程序员做了一个有意思的投票统计(原始链接请见:《程序员:你认为最难做的事情是什么?》),该投票是让程序员从以下几个选项中选出平时在工作中自己认为最难做的事情:
- 做项目方案设计
- 编写测试用例
- 撰写设计文档
- 向别人解释我们在做什么事情
- 实现你不认同的feature
- 在别人写的代码基础上做改造
- 与人沟通
- 给函数、变量命名
- 进行工作量估时
也许在大家的印象中,撰写设计文档和在别人写的代码基础上做改造应该是最难的事情。但是最终的投票结果确让大家意想不到,这次投票一起有4522名程序员参与了投票,排在第一位的是给函数、变量命名:
大概一半的人投票给了给函数、变量命名,从这次投票结果我们足可以看出:给函数、变量命名虽然是一件再普通不过的事情,但是要想把这件事做好绝非易事。那么今天,我们就来聊一聊如何给函数取一个好的名字。以下是本文大纲目录:
一.常见的函数命名风格
二.函数命名的最高境界
三.函数命名最佳实践
若有不正之处请多多谅解,并欢迎批评指正。
请尊重作者劳动成果,转载请标明原文链接:
https://www.cnblogs.com/dolphin0520/p/10567879.html
一.常见函数命名风格
目前来说,最常见的函数命名主要有两种风格:驼峰命名和帕斯卡命名。
- 驼峰命名:多个单词组成一个名称时,第一个单词全部小写,后面单词首字母大写;如:
1
|
public void setUserName(String userName);
|
- 帕斯卡命名:多个单词组成一个名称时,每个单词的首字母大写;
1
|
public void SetUserName(String userName);
|
两种命名风格都是ok的,但要保证一点,对于一个团队或者一个项目,需要根据语言本身的推荐命名方式做好约定。比如java一般都采取驼峰命名,C#采取帕斯卡命名。
二. 函数命名最高境界
我们通常说:天下武功,唯快不破。那么对于函数命名来说最高境界是什么呢?我认为是:见字如面,顾名思义,就是看到函数的名字就知道这个函数具体做了哪些事情。
比如上面的函数:
1
|
public void setUserName(String userName);
|
但是下面这个函数命名就不是一个好的命名:
1
|
public String addCharacter(String originString, char ch);
|
这个函数,一咋看,还不错,从函数字面意思看是给某个字符串添加一个字符。但是到底是在原有字符串首部添加,还是在原有字符串末尾追加呢?亦或是在某个固定位置插入呢?从函数名字完全看不出来这个函数的真正意图,只能继续往下读这个函数的具体实现才知道。
而下面这几个名字就比上面要好得多:
1
2
|
public String appendCharacter(String originString, char ch); // 追加到末尾
public String insertCharacter(String originString, char ch, int insertPosition); // 插入指定位置
|
三. 函数命名最佳实践
1)要领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)要领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 |
3)要领3:函数取名最忌讳"名不副实"
函数取名最忌讳的是"名不副实",举个例子,假如有个Cache类,里面有个函数判断key是否过期:
1
2
3
4
5
6
7
8
9
10
11
12
13
|
public boolean isExpired(String key) {
// 当前时间戳
long curTimestamp = DateUtils.nowUnixTime();
// 获取key的存入时间戳
long storeTimestamp = getStoreTimestamp(key);
if (curTimestamp - storeTimestamp > MAX_EXPIRE_SECONDS) {
// 注意这个地方的delete是个隐藏逻辑
delete(key);
return true ;
}
return false ;
}
|
上面这个函数从函数字面意思看是判断key是否过期,但是!!它居然在函数里面隐藏了一段特殊逻辑:如果过期则删除掉key。这个就是典型的"名不副实",这个是最忌讳的,会给后续的开发人员留下"巨坑"。
有两种方式去优化这段代码:
- 方式一:将隐藏逻辑去掉
1
2
3
4
5
6
7
8
9
10
11
|
public boolean isExpired(String key) {
// 当前时间戳
long curTimestamp = DateUtils.nowUnixTime();
// 获取key的存入时间戳
long storeTimestamp = getStoreTimestamp(key);
if (curTimestamp - storeTimestamp > MAX_EXPIRE_SECONDS) {
return true ;
}
return false ;
}
|
- 方式二:改变函数名字
1
2
3
4
5
6
7
8
9
10
11
|
public int deleteIfExpired(String key) {
// 当前时间戳
long curTimestamp = DateUtils.nowUnixTime();
// 获取key的存入时间戳
long storeTimestamp = getStoreTimestamp(key);
if (curTimestamp - storeTimestamp > MAX_EXPIRE_SECONDS) {
return delete(key);
}
return 0 ;
}
|
4)要领4:多查询条件的函数名字谨慎使用介词by
我们平时在写查询接口时,假如有多个查询参数怎么办?每个通过by一起连接依赖?No!这绝对不是明智的方式。假如一开始产品的需求是通过学生姓名查询学生信息,写出来的可能是这样的函数:
1
|
public List<Student> getByName(String name);
|
然后突然又有一天产品提出了新的需求,希望同时可以通过姓名和电话号码来查询学生信息,那么函数可能变成这样了:
1
|
public List<Student> getByNameAndMobile(String name, String mobile);
|
接着,没过多久,产品又希望根据学生年龄来查询学生信息,那么函数可能变成这样了:
1
|
public List<Student> getByNameAndMobileAndAge(String name, String mobile, int age);
|
如果这样来给函数命名,那么你的噩梦大门即将打开。
通常比较好的做法是:
如果是通过主键id来查询,那么可以通过by来连接查询信息,比如:
1
|
public Student getByStudentId( long studentId);
|
如果是通过其他属性来查询,并且未来会存在多个组合查询的可能性,建议进行封装,比如:
1
|
public List<Student> getStudents(StudentSearchParam searchParam);
|
最后,建议大家平时在写代码过程中,不要怕在函数命名上耗费时间,一个好的函数命名在后期会大大减少你代码重构的成本,争取对函数命名做到"见字如面"~
转载于:https://www.cnblogs.com/changbaishan/p/10577777.html
工程实践:给函数取一个好的名字相关推荐
- 工程实践:如何给变量取一个好的名字
工程实践:如何给变量取一个好的名字 在上一篇文章中跟大家分享了关于函数命名的一些实践心得,今天我们继续命名这个话题,来讲一讲如何对变量命名. 以下是本文的目录大纲: 一. 变量命名风格 二. 变量命名 ...
- wpf中使用控件时,最好给控件取一个好的名字
wpf中使用控件时,最好给控件取一个好的名字, 比如按钮A可以 取名为 btnA 这样使用会是编程清晰.
- 给数据库表列取一个好的名字
做父母的总希望给自己的子女取一个响亮的.富有含义的名字.有时候家长为了找到一个合适的名字,会拿起平时碰都不碰的汉语大辞典翻个好几天.天下父母心呀.其实在数据库中创建对象时,管理员也要对其进行命名. 其 ...
- 给函数取一个“好”名字
参考资料:https://www.cnblogs.com/dolphin0520/p/10567879.html 一.常见的函数命名风格 目前,函数最常见的两种命名风格: (1)驼峰命名法: 多个单词 ...
- 【C#】如何给变量取一个好的名字
讲一讲如何对变量命名. 以下是本文的目录大纲: 一. 变量命名风格 二. 变量命名最高境界 三. 变量命名最佳实践 一.变量命名风格 变量命名风格通常会根据不同的变量类型来区分,以Java语言为例,根 ...
- 转载--给函数取个好名
工程实践:给函数取一个"好"的名字 - Matrix海子 - 博客园 (cnblogs.com) 我发现,我给函数起名简直就是一个老大难的问题,并不是不知道这个函数是 ...
- 字节跳动混沌工程实践之场景化主动实验
背景 从 2010 年 Netflix 上线 Chaos Mokey 的第一个版本到现在,虽然混沌工程发展已历时十年,但其实只在少数大厂里面有较成熟的落地,对绝大部分研发同学来说,混沌工程还是一个比较 ...
- 教你如何给孩子取一个好名字!
古语有云:"赐子千金,不如教子一艺:教子一艺,不如赐子好名."可谓道出了姓名对人的重要性.那么,作为父母如何给孩子起一个大富大贵.提升运势的名字呢? 首先,须以孩子的生辰八字取用神 ...
- C++ 工程实践:避免使用虚函数作为库的接口
原文: http://blog.csdn.net/Solstice/archive/2011/03/12/6244905.aspx 陈硕 (giantchen_AT_gmail) Blog.csdn. ...
- C++ 工程实践(5):避免使用虚函数作为库的接口
https://blog.csdn.net/solstice/article/details/6244905 摘要:作为 C++ 动态库的作者,应当避免使用虚函数作为库的接口.这么做会给保持二进制兼容 ...
最新文章
- 【多线程】Java线程面试题 Top 50(转载)
- NP-Hard问题及组合最优化问题
- kubernetes (1)基本概念
- LSTM股票价格预测
- 2021牛客暑期多校训练营3 I Kuriyama Mirai and Exclusive Or 差分 + 二进制分治
- Mac OS X上的Java Memcached
- mvc路由 html,asp.net-mvc – ASP.NET MVC路由从html页面开始
- 宽量程电压电流 stm32_电压、电阻知识点汇总
- D1net阅闻:Google Analytics增AI自动化分析功能
- oss按量付费_ACP云计算笔记—VPCamp;OSS
- 5、Spring Cloud-声明式调用 Feign(下)
- java读取txt生成excel_读取TXT文件内容,生成Excel文件
- 人工智能的主要优势是什么?
- PHP实现输入地址,获取当前位置的经纬度,$lng和$lat即为经纬度的返回值
- 拼音打字时不定时出现重复字母
- python计算各类型电影的评分,Moviedata-10M电影数据集统计分析之源码分享(Python)...
- Leetcode(347)——前 K 个高频元素
- 单片机-结构体函数指针高级使用方法
- vrrp mstp 配置实验(学习笔记)
- Dubbo线程池满导致宕机的案例分析解决
热门文章
- 牛客网Java刷题知识点之ArrayList 、LinkedList 、Vector 的底层实现和区别
- Node.js 使用http客户端向网站请求数据并保存
- 精彩回顾|DBDI 数据智能技术研讨沙龙(杭州站)顺利举办
- php设计模式实战之--观察者模式
- C3P0的几种使用方法(非JNDI)
- 美国航空航天局(NASA)高度集成WebFOCUS和SharePoint
- “拯救网站运维经理赵明”已近尾声
- RT-Thread源码获取--Keil官网和GitHub
- webrtc项目编译报错(image not found)
- 物化视图(materialized view) 实现数据迁移、数据定时同步