Java编程规范(一)

最近在看一本有关Java编程规范的书,书中精炼阐述了使用java语言时应该遵循的一些原则。接下来的一段时间我将在这里总结个人学习内容,也但愿这一系列文章可以对有须要的人有所帮助。java

不考虑任何编码规范的代码每每存在不少Bug,严重状况下还会制约软件开发的进度。良好的编程规范不只能使团队里的每一个人都能轻松的阅读并理解其余人的代码、减小Bug的产生,并且让后期的维护工做更加行之有效,从而使代码更具准确性、健壮性、可维护性与可扩展性。因此拥有良好一致的编程规范对于一个团队相当重要。编程

1、通常原则

(一)保持原有风格

在修改原有的软件时,应该保持原有代码的编写风格。学习

咱们不该该在原有的代码中引入新的风格,在同一段代码中使用不一样的编程风格会让咱们的代码难以理解。同时咱们也不该该重写旧的软件去迎合新的风格,这样极可能会使原来的程序产生严重的功能缺陷。编码

(二)坚持最小惊奇原则

在编码过程当中尽可能避免可能让软件用户感到意外的作法。代码规范

用户在使用软件中产生的任何交互行为必须都是可预见的,除非在说明文档中明确记录下全部的很是规行为而且说明这样作的理由。为了达到这一目的,在Java软件的开发过程当中应该遵循如下几点:对象

  • 简单性:构建简单的类和方法。接口

  • 清晰性:明确每一个变量、类、接口、方法、对象的用途。开发

  • 完整性:提供用户所指望的完整的程序功能,而且为此编写完整的说明文档。文档

  • 一致性:类似的实体,其外观和行为也要大体相同;反之亦然。原型

  • 健壮性:对错误和异常作出预测,而且在说明文档中提供相应的解决办法。

(三)第一次就作对

将以上的这些规则应用到咱们编写的任何代码中,而不仅是产品自己的代码。

一般状况下,那些原型代码最终都会被写入成品软件中。因为咱们一开始就已经遵循了编码规范,因此咱们不须要为特定的产品修改代码规范。那些阅读咱们代码的人也会从中受益不浅。

(四)记录全部非规范行为

没有什么标准是完美且可以放之四海而皆准的,有时候你会发现本身不得不偏离已经创建好的标准体系。

标准并非适用于任何地方,在打破一条规则以前,咱们须要确保咱们已经对这条准则有了深刻的理解并且清楚打破规则后的后果。此外,咱们应该在文档中记录下这样作的理由。

以上就是通常原则的内容,没有涉及具体的代码,可是咱们在进行下面的学习或者编码以前应该对以上的内容有所理解。

相关文章
相关标签/搜索