代码简洁之道之有意义的命名

1、名副其实
变量、函数或者类的名称应该已经答复了所有的大问题。它应该告诉你,它为什么会存在,它做什么事,应该怎么用。如果名称需要用注释来补充,那就不是真正的名副其实。

2、避免误导
必须避免留下掩藏代码本意的错误线索。应该避免使用与本意相悖的词。特别要注意的是不要用字母l和o或者O来当变量名,因为他们和1、0太相像了。

3、做有意义的区分
如果缺少明确的约定,变量moneyAmount就与money没区别,customerInfo与customer没区别,accountData与account没区别,theMessage也与message没区别。要区分名称,就要以读者能鉴别不同之处的方式来区分。

4、用读的出来的名称
即不要起稀奇古怪的名字。

5、使用可搜索的名称
找MAX_CLASSES_PER_STUDENT很容易,但找到数字7就比较麻烦了。名称的长短应与其作用域大小相对应。

6、避免使用编码
无谓的成员前缀是没有意义的。

7、避免思维映射
不应当让读者在脑中把你的名称翻译为他们熟知的名称。

8、类名
类名和对象名应该是名词或名词短语,类名不应该是动词。

9、方法名
方法名应当是动词或者动词短语,属性访问其、修改器和断言应该根据其值命名,并加上get、set和is前缀。

10、别扮可爱
不要用俚语或俗语命名。

11、每个概念对应一个词
每个概念对应一个词,并且一以贯之。不要同一个概念在不同的类中有不同的描述。

12、别用双关语
避免将同一单词用于不同目的。同一术语用于不同概念,基本上就是双关语了。

13、使用解决方案领域名称
记住,只有程序员才会读你的代码。所以,尽管用那些计算机科学术语、算法名、模式名、数学术语吧。

14、

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Java代码整洁之道是指编写易于理解、易于维护、可扩展性强的高质量代码的一系列准则和实践。以下是一些Java代码整洁之道的要点: 1. 命名规范:使用有意义的变量、方法和类名,遵循驼峰命名法,并避免使用缩写和单个字符作为名称。 2. 函数和方法的简洁性:函数和方法应该尽可能短小,只做一件事,并遵循单一职责原则。避免过长的函数和方法,可以通过提取子函数或方法来减少代码复杂性。 3. 注释和文档:使用清晰的注释来解释代码的意图和逻辑,但不要过度注释。另外,编写良好的文档注释,以便其他开发人员能够理解和使用你的代码。 4. 避免重复代码:重复代码会增加维护成本,应该尽量避免。可以通过提取公共代码块为方法或函数,或者使用继承、接口等方式来实现代码的重用。 5. 异常处理:合理处理异常情况,避免捕获所有异常或忽略异常。根据具体情况选择合适的异常处理方式,例如抛出异常、记录日志或返回默认值。 6. 单元测试:编写单元测试是保证代码质量的重要手段。每个方法都应该有对应的单元测试,覆盖各种情况,确保代码的正确性和稳定性。 7. 代码格式化:统一的代码格式可以提高代码的可读性。使用合适的缩进、空格、换行等格式化规范,并使用代码格式化工具进行自动格式化。 8. 设计模式和面向对象原则:熟悉常用的设计模式和面向对象原则,如单一职责原则、开闭原则、依赖倒置原则等,合理应用于代码设计中。 9. 持续重构:随着需求的变化和代码的演进,及时进行代码重构是保持代码整洁的关键。通过重构,可以改进代码结构、提高可读性和可维护性。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值