05 | 经验总结：如何给你的代码起好名字？
该思维导图由 AI 生成，仅供参考
为什么需要一个好名字？
荧光笔
直线
曲线- 深入了解
- 翻译
- 解释
- 总结
如何给你的代码起好名字？ 起一个好的代码名字并不是一件简单的事情，但却是非常重要的。一个好的名字能准确地代表代码背后的东西，让代码更易读、易理解，同时也能提升我们的编码效率。本文介绍了为什么需要一个好名字，以及命名规范的重要性。文章还介绍了常见的命名方法，包括驼峰命名法、蛇形命名法、串式命名法和匈牙利命名法，并且针对Java语言给出了相应的命名规范。文章通过实例和规范的对比，帮助读者更好地理解命名规范的重要性和实际应用。 在给代码取名字时，需要遵守三条原则：名字要有准确的意义，严格遵守命名规范，可读性优先。取名字要做到“信、达、雅”（准确、直观、优美）。文章还提供了一段Java代码供读者优化命名，鼓励读者亲自感受如何优化代码名字。 总之，取好名字是编写优秀代码最基础也是最重要的一项修炼。读者可以通过本文介绍的原则和规范，将其用于新代码，或者整理老代码，从而立刻感受到代码质量的大幅度提升。
《代码精进之路》，新⼈⾸单¥59
全部留言(33)
- 最新
- 精选
- pyhhou置顶思考题： 1. 第四行：class Solution -> class TwoSumSolution 2. 第九行：public int[] twoSum(int[] nums, int target) { -> public int[] twoSumSolve(int[] numbers, int targetNumber) { 3. 第十行：map -> targetNumbersRemain 4. 第十二行：complement -> remain 望老师指点，感觉命名确实可以让程序变规范、写代码变高效、读起来更直观、管理起来更方便，谢谢老师
作者回复: 改得漂亮！ 我真没有想到使用remain，语义会更清晰些。👍 类似的，参数名也不是很清晰，也可以改改。
2019-01-1518 
richey范老师，一直有个疑问，有时候为了方法名或类名更好的表意，会把名字起的比较长，但名字太长也感觉不太优雅，这方面有什么好的经验吗？作者回复: 如果名字没有超过20个字符，长一点也没关系。如果是代码内部使用标识符，要是使用它的代码还能保持在80个字符以内，再长一点也可以。毕竟，容易理解是最重要的。 确实有不方便的时候，可以使用首字母缩略词，比如把server name indication缩略成sni，使用类似于sniServerName这样的命名。 缩略语离开语境，就很难理解了，我们可以通过注释或者接口规范弥补这个缺陷，解释清楚缩略语代表什么意思，以及缩写的名字具体的含义。 比如说， @param sniServerName the server name of a Server Name Indication (SNI)
2019-01-1416
J推荐FindBugs插件,不规范命名可以识别出来作者回复: 是的，工具可以帮助我们查一查。 顺便的，FindBugs停止更新了，后继者是SpotBugs。前面的留言区有小伙伴提到过。
2019-01-14216
🍃Spring🍃抛开编程，其实我们的工作是一种表达，或者沟通，不同的是我们在于两个截然不同的两个主体表达，第一个计算机，它有他的规范，只要满足就能实现。第二个就是人，我们自己，有章有法的表达就是最好的沟通。作者回复: 👏此处有掌声👏
2019-01-1410
人脑逆向工程师对国内程序员来说提升英语水平会比较明显有助于改善变量命名作者回复: 😂坚持使用良好的变量命名，反过来也促进英文水平。
2019-03-185
雷小鸿简单说下我们dao层命名。一般我们dao层都是和数据库交互的。一个dao类对应一个数据库表。可以用数据库表名+dao这样。具体名字严格按照类命名规范。一个表映射一个实体dao类。这个dao类里面的方法只操作对应的表。如果你不是这样的dao。可以相同的业务放在一个dao里面。根据相同的业务命名。只是给那位同学提供参考不一定完全正确。作者回复: 谢谢！
2019-01-155
MOV AX,0编写这段代码时，有两个书写问题，也是我一直所困惑的： 1.参数中存在多种类型，是否有根据参数类型来在参数声明中，排列参数的规范呢？比如例子中的 (int[] numbers, int targetNumber)，我希望参数列表呈现出一种递减/增的趋势，由集合到数值，再到布尔类型，或者反过来。例如：Map<String, Object> idNameMap, List<CustomerDto> customers, long minBalance, boolean isMember。每个参数所包含元素的复杂度递增/递减，让我觉得有一种美感。 不知老师怎么看？ 2.类似1中的问题，在方法体内，初始化参数时，我希望参数的初始化顺序是由简至繁。虽然表述有歧义， 请看我之前贴的代码： int testTargetNumber = 7; int[] testNumbers = new int[]{1, 2, 3, 4, 5}; 我希望在保证所有初始化的参数，尽量贴近它的首次调用点的前提下，做到简单类型先初始化，每行代码的长度从上至下由短到长。 可能这些问题，看起来都很无聊没有太多可讨论的地方。但我认为编码就是艺术，艺术在于精进，再简单的东西也要尽量做的赏心悦目。起初这门课程上线时，我也有看大纲，很多已经从sonar刻到骨子里了，想着没有太大必要再买。但一位好友近期要转java开发，我也一时想不到什么特别好的书给他参考。某天点开极客时间，又看到这门课，买下来看了下，确实深有感触。如果自己都没确认好不好，不敢误人子弟。趁着这个机会推荐给他，我自己也再学一遍，也算与他共同学习吧，不知他有没机会看到这段话。也希望老师对我的代码给一点建议，感激不尽！作者回复: 第一个问题是个好问题。我还没有看到过这方面的书面规范。一般情况下，我使用的方法是按照参数的关联度，或者参数的逻辑关系。 比如，String.valueOf(char[] data, int offset, int count)，最重要的是data，所以放在第一位。然后是从什么地方开始，使用多少个字符。 我们如果阅读这个方法的规范，它写的是“Returns the string representation of a specific subarray of the char array argument.” 首先提到的就是data这个参数，然后再说明data的附加条件。 我觉得可以试试，如何用语言把这个方法描述出来。参数出现的描述中顺序大致就可以是参数在方法中的出现顺序。 第二种初始化的顺序，也是我常用的顺序。 可能会有人觉得规范无聊，但是掌握了它的人都知道，好的规范，赏心悦目的代码，可以理清思路，提高效率，减少错误，减轻疲劳。只是大家不知道为什么好，就不知道为什么要规范。所以我也选择了一个不太讨好市场的方式，说了很多为什么好的道理。这确实不性感，不带劲！ 我非常感谢你能给朋友推荐这个专栏。我希望这个专栏的打开方式是从这里看看为什么和一些小例子，找一个详尽的规范看看详细的怎么办，比如阿里巴巴的规范，Google的规范，Java自己的规范等等。然后，使用练手题练习一下，然后把学到的、认可的规范用到自己实际的代码里去。 写好代码，是一个长期的修行。我自己也在不停地琢磨怎么可以做的更好。共勉！
2019-01-304
allean认真规范自己写的代码，感觉很开心了作者回复: 代码写的好看，真的心情好的。
2019-01-143- MOV AX,0非常感谢您的细心回复！实际工作中，确实会返回空集合，这也是我一直的习惯。因为在例子中返回异常，所以还是按异常来写了。main方法是写给其他初学者看的，刚开始工作时JUnit都不会，只会main来测... 有不少同学提到了阿里的代码规范插件，配合SonarLint更佳！我们公司对异常的处理，是使用了一个ApiResult的类封装返回结果，假设Facade接口内捕获了报错，会使用: LOGGER.error("error msg in logger", e); return result.error("error msg to invoker"); 这样调用方，可以通过静态方法ApiResult.isSuccess(result)/ApiResult.isFail(result)来判断接口调用是否成功，通过result.getMsg()即可获取错误信息。 对外接口是绝对不可以抛出异常的，内部调用的服务XxxxService是可以抛出异常的，DAL层不做参数校检且不对外提供服务，参数的校检和异常捕获也应在Service层完成。关于结果返回封装类，网上有很多实现可以参考。
作者回复: 这种ApiResult的处理方式让我想起了C语言时代的错误处理方式。
2019-01-311 
等dao层，与数据库交换层，一般写sql语句，是不是用sql的功能来命名？ 比如getStudentinfo之类的作者回复: 谢谢。我对数据库比较陌生了，小伙伴们能不能帮着回答下这个问题？ > 如果多个（至少5个）方法调用同一个dao，这个dao要怎么命名好点？还是，以业务功能划分，把这个dao分开？ 以前我做数据库代码的时候，数据库的设计一般按照业务逻辑来的。数据存取接口虽然不涉及具体的业务逻辑，但是由于数据库的设计是按照业务数据来做的，数据存取接口也是按照业务逻辑设计的。这样，接口的命名体现的也是业务数据处理的细分功能。命名的时候，也是使用业务的逻辑表达方式。 现代的数据库模型是什么样子的，我就不懂了。希望看留言区的小伙伴可以帮帮我。
2019-01-1421
