代码整洁之道的一些总结(二)

接着上一篇,这篇主要是函数的规则。
一、函数
系统是由程序、子程序、函数组成的,如今只有函数存活了下来,那么我们应该如何写好函数呢?

  1. 首先是要短小,第二是还要更短小,每行都不应有150个字符,函数不该有100行那么长,20行封顶最佳。
  2. 函数应该做一件事。做好这件事。只做这件事。 功能要单一,对准一点。
  3. 每个函数一个抽象层级。基础概念和细节不应混杂到一块。
  4. switch语句,写得比较短比较难。我们无法避免switch语句,确保switch埋藏在较低的抽象层级,而且永远不重复。
  5. 使用描述性的名称。名称尽量描述函数需要完成的事情。
  6. 函数参数。最理想的参数数量是零,其次是一,再次是二、尽量避免三。参数与函数名处于不同的抽象层级,所以能少则少吧。超过三个要考虑封装为类了。
  7. 无副作用。函数承诺只做一件事,所以不要加入一些未按照预期的改动。
  8. 分割指令与询问。函数要么做什么事,要么回答什么事,二者不可兼得。
  9. 使用异常代替返回错误码。try{}catch{}
  10. 别重复自己。重复是软件中一切邪恶的根源。
  11. 结构化编程。Dijkstra认为,每个函数、函数中的每个代码块都应该有一个入口、一个出口。意味着每个函数中只该有一个return语句。
  12. 如何写出这样的函数。不断打磨,精雕细琢。
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
Java代码整洁之道是指编写易于理解、易于维护、可扩展性强的高质量代码的一系列准则和实践。以下是一些Java代码整洁之道的要点: 1. 命名规范:使用有意义的变量、方法和类名,遵循驼峰命名法,并避免使用缩写和单个字符作为名称。 2. 函数和方法的简洁性:函数和方法应该尽可能短小,只做一件事,并遵循单一职责原则。避免过长的函数和方法,可以通过提取子函数或方法来减少代码复杂性。 3. 注释和文档:使用清晰的注释来解释代码的意图和逻辑,但不要过度注释。另外,编写良好的文档注释,以便其他开发人员能够理解和使用你的代码。 4. 避免重复代码:重复代码会增加维护成本,应该尽量避免。可以通过提取公共代码块为方法或函数,或者使用继承、接口等方式来实现代码的重用。 5. 异常处理:合理处理异常情况,避免捕获所有异常或忽略异常。根据具体情况选择合适的异常处理方式,例如抛出异常、记录日志或返回默认值。 6. 单元测试:编写单元测试是保证代码质量的重要手段。每个方法都应该有对应的单元测试,覆盖各种情况,确保代码的正确性和稳定性。 7. 代码格式化:统一的代码格式可以提高代码的可读性。使用合适的缩进、空格、换行等格式化规范,并使用代码格式化工具进行自动格式化。 8. 设计模式和面向对象原则:熟悉常用的设计模式和面向对象原则,如单一职责原则、开闭原则、依赖倒置原则等,合理应用于代码设计中。 9. 持续重构:随着需求的变化和代码的演进,及时进行代码重构是保持代码整洁的关键。通过重构,可以改进代码结构、提高可读性和可维护性。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

小鱼儿LY

一切随缘

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值