良好的编程习惯

1.避免使用大文件,如果一个文件里的代码超过300~400行,必须考虑将代码分开到不同类中。 
2.避免写太长的方法,一个典型的方法代码在1~30行之间。如果一个方法发代码超过30行,应该考虑将其分解为不同的方法。 
3.方法名需能看出它作什么,别使用会引起误解的名字。如果名字一目了然,就无需用文档来解释方法的功能了。
4. 一个方法只完成一个任务,不要把多个任务组合到一个方法中,即使那些任务非常小。 
5.别在程序中使用固定数值,用常量代替。
6.别用字符串常数,尽量用资源文件。 
7.避免使用很多成员变量,声明局部变量,并传递给方法。 
8.不要在方法间共享成员变量,如果在几个方法间共享一个成员变量,那就很难知道是哪个方法在什么时候修改了它的值。必要时使用enum,别用数字或字符串来指示离散值。
9.别把成员变量声明为 public或 protected。都声明为private 而使用 public/protected的Properties。
10.不在代码中使用具体的路径和驱动器名,使用相对路径,并使路径可编程。永远别设想你的代码是在"C:"盘运行。你不会知道,一些用户在网络或"Z:"盘运行程序。 
11.应用程序启动时作些“自检”并确保所需文件和附件在指定的位置。必要时检查数据库连接,出现任何问题给用户一个友好的提示。 
12.如果需要的配置文件找不到,应用程序需能自己创建使用默认值。如果在配置文件中发现错误值,应用程序要抛出错误,给出提示消息告诉用户正确值。错误消息需能帮助用户解决问题。
13.注释:别每行代码,每个声明的变量都做注释。在需要的地方注释。可读性强的代码需要很少的注释,如果所有的变量和方法的命名都很有意义,会使代码可读性很强并无需太多注释。行数不多的注释会使代码看起来优雅。如果因为某种原因使用了复杂艰涩的原理,必须为程序配备良好的文档和详细的注释。对注释做拼写检查,保证语法和标点符号的正确使用。
 

 
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Spring Boot编程习惯是指在开发Spring Boot应用程序时应该遵循的一些最佳实践以及一些规范性要求。这些编程习惯旨在提高代码的可读性、可维护性和可扩展性,让Spring Boot应用程序更加易于理解和维护。 1. 遵循单一职责原则 编写代码时应该遵循单一职责原则,即一个类或一个方法只负责一项职责。这样可以使代码更加清晰,易于维护和测试。 2. 遵循关注点分离原则 关注点分离原则是指将不同的关注点分离开来,避免在同一个类或方法中混杂多个关注点。例如,将业务逻辑与数据访问进分离。 3. 统一的命名规范 应该为类、方法、变量等统一的命名规范,以提高代码可读性。常见的命名规范包括驼峰命名法、下划线命名法等。 4. 避免魔法数字 应该尽量避免在代码中使用魔法数字,应该将这些数字定义为常量,以便于更好的理解和维护代码。 5. 异常处理机制 应该养成在代码中使用异常处理机制的编程习惯,以及时捕获并处理潜在的异常情况。对于不同的异常情况,应该使用不同的异常类型。 6. 注释规范和文档说明 编写代码时应该养成良好的注释和文档说明的习惯。注释应该清楚明白,说明代码的作用和意图,以方便后续维护。同时,应该提供详细的文档说明,包括接口定义、使用说明等。 总之,Spring Boot编程习惯是开发人员们在开发Spring Boot应用程序时应该遵循的一些最佳实践和规范性要求,这些习惯可以提高代码的可读性、可维护性和可扩展性,让Spring Boot应用程序更加易于理解和维护。

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值