
课程咨询: 400-996-5531 / 投诉建议: 400-111-8989
认真做教育 专心促就业
规范性一直以来都是程序员在写代码的时候需要遵守的一个开发原则,下面我们就通过案例分析来了解一下,软件开发规范性如何操作。
代码格式的意义
代码是用来描述业务逻辑的表达语言。而代码的格式则是为了更精准地表达业务逻辑。
有的人可能会认为,无论多么的难以阅读,只要能完成产品预定的业务逻辑,就是好的代码。我认为这个想法是不对的。主要原因在于,在大型项目和持续维护的过程中,以及其他人在进行backup的时候,比起当时的业务逻辑是否准确,能否让人理解你的意图更加重要。而代码格式便是服务于此:
为代码提供额外的上下文信息。
尽管当前各种现代IDE提供了方便的格式化操作。但是这种格式化主要是针对一些简单的格式比如:
元素之间的空格
import的位置
括号之间的缩紧
尽管上述这些在实际各种中也很重要,由于有IDE的辅助,我们可以减少一些对于这方面的关注。
注:但是建议调整格式的时候单独提交commit,否则与万一与业务提交混合在后续比对修改点的时候就比较恶心。
代码格式总则
如同上文所说的,代码格式是为了提供代码业务之外的上下文信息。那么在这里我们就可以明确一下代码格式提供这个信息的意义:
代码格式为代码提供符合人们阅读直觉的额外信息。
当然,这个人类阅读直觉不同的语言可能不一样,这里指的是大多数Java软件中使用的规则。而这里我列举一些主要值得注意的点,主要有:
从上往下阅读
相同内容聚集
概念间分割
从上往下阅读
由于人们的阅读顺序是从上到下,从左到右的方向,所以人们常常会假定逻辑顺序也是如此的。一般来说可以有:
变量在前
Java中的类属性一般在前面。而在方法中也一般建议将所使用到需要声明的变量,这样便于在阅读方法的时候对于接下来会出现的变量一目了然。同时,如果你发现变量与实际使用的距离太远了,那说明这个方法的行数太长了,应该优先确认一下是否可以抽取方法。
调用在前
由于人们的阅读顺序会暗示逻辑顺序,所以对于调用的方法,好在被调用方法的上面。当然了,如果不能全部满足这种情况的话,至少区分一下主次。如果大体满足这个排序逻辑后,整体java文件会呈现一种:主要对外提供逻辑在前,内部被调用逻辑在后的情况。那么当开发人员浏览java文件的时候,应该在浏览上层的public方法的时候,就大概知道类的大概流程了。
【免责声明】:本内容转载于网络,转载目的在于传递信息。文章内容为作者个人意见,本平台对文中陈述、观点保持中立,不对所包含内容的准确性、可靠性与完整性提供形式地保证。请读者仅作参考。更多内容请加danei0707学习了解。欢迎关注“达内在线”参与分销,赚更多好礼。