代码整洁之道-1 如何命名

在学校的时候,老师们都说要学会为代码加注释,这是一个良好的习惯,注释越多越好。
但是实际并不是这样,对于代码来说,并不是注释越多越好。
当你的代码不得不需要特别多的注释才能让别人看懂,只能说明你的代码不够整洁,不得不用长篇大论来解释自己的代码。

下面所有的规则都是建议,并不是强制性的要求,要根据实际情况去选择更加合适的写法。

命名很重要,要多花时间去想。

如果想道了更合适的,就多花些时间把原来的替换掉。(不要影响他人使用)

  1. 需要添加注释来说明的命名就是不够完美的命名
    尽量让自己的命名不加注释也能让别人看懂。
  2. 不要让名称太过相似:
    如果你的项目中同时存在product,productInfo,productData这三个类,一定会让人看着就感觉头大。
  3. 类名推荐使用名词和名词短语,方法推荐使用动词或动词短语。
  4. 为每一个抽象概念选一个词,并一以贯之。
  5. 灵活使用语境:
    相同的变量名称放入不同的语境中会表示不同的意思。可以利用这一点减短自己的变量名称,让语境来帮你将变量解释完全。
  6. 不要害怕名称过长,相对于名称过长所造成的麻烦。没有解释清楚意思更加麻烦。
  • 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、付费专栏及课程。

余额充值