如何写好代码

怎么样才能写好代码?

代码要有以下特点 可读性、可扩展性、可复用性、可维护性、低耦合、 高内聚和遵循设计原则

  1. 可读性强
    有时候写的代码比较晦涩难懂,或者具有专业性,但通过代码注释可以很好让后面的人知道你的逻辑;
    代码命名要有意思,不要随便定义a,b,c这种,谁知道你想表达什么,定义时要让人看到就知道想表达什么;
  2. 高性能
    在编写代码应该考虑时间复杂度和空间复杂度,尤其咱么在遍历或者写递归算法的时候;
  3. 遵循代码规范
    目前咱们idea可以继承Alibaba Java Coding Guidelines插件平时可以对扫码进行扫描,调整;
    使用Save Actions 自动格式化代码等-;
    也可以继承Code Formatter插件;
    定义一套代码注释模板等;
  4. 易于测试
    好的代码要易于测试,编写可测试的代码,并编写单元测试(UT)来覆盖功能点。
    写代码注意一下几点:
    • 代码不能过长
      一个方法只能有一个功能,比如你查询功能里面还有个保存功能,这种是不可取的。
    • 使用依赖注入和接口 降低代码之间的耦合性。
  5. 异常处理
    使用try-catch语句捕
    获异常,并在适当的情况下记录错误信息或抛出新的异常,当然还要建立合适的异常
    全局捕获机制。
  6. 文档和注释
    为关键部分和复杂逻辑编写详细的文档和注释,以帮助其他开发者更容易地理解和维
    护代码。同时,保持文档和注释的更新,以反映代码的最新状态
  7. 可复用性
    好的代码应该具有可复用性,避免重复编写相同的代码。将通用功能抽取成独立的模
    块或库,以便在多个项目或模块中使用。
    比如我们常用的工具类,封装的请求返回对象,第三方的插件德国
  8. 易于维护
    好的代码应该具有良好的模块化和低耦合度,使其易于修改和扩展。遵循单一职责原
    则,确保每个类和方法只负责一项任务。
  9. 可扩展性
    好的代码应该具有良好的可扩展性,即当需求变更或新增功能时,能够方便地进行扩
    展,而不需要大规模地改动现有代码。

你可能感兴趣的:(设计模式,设计模式)