ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

代码精进之路——如何写好代码

2020-02-05 17:05:58  阅读:208  来源: 互联网

标签:缩进 精进 代码 规范 注释 如何 static 方法


如何才能写好代码呢?我们可以从代码规范、起好名字、写好注释以及合理划分代码块等反面优化自己的代码。

代码规范

编码规范指的是针对特定编程语言约定的一系列规则,通常包括文件组织、缩进、注释、 声明、语句、空格、命名约定、编程实践、编程原则和最佳实践等。

规范的代码,可以降低代码出错的几率。比如之前提到的因为没有正确的缩进和括号导致的 bug。如果是一个追求或者遵从代码规范的程序员就很难犯这样的错误。

复杂是代码质量的敌人。 越复杂的代码,越容易出现问题,并且由于复杂性,我们很难发现这些隐藏的问题。在编码的时候,我们应该尽量使代码风格直观、逻辑简单、表述直接。

规范的代码,降低软件维护成本。大家写的代码都遵循规范,代码审阅人员看的舒心,后期维护人员也能看懂。就算是自己维护自己的代码,我相信在三个月后再看自己写的代码也一定会为当时的自己点赞,明确的变量,准确的缩进,简单的逻辑,恰当的注释...

一件东西,无论其实用性多强,终究比不上让人心情愉悦更为实用。

优秀的代码不 光是给自己看的,也是给别人看的,而且首先是给别人看的。

起好名字

为什么需要一个好的名字?首先我们先看一个列子:

public byte[] isEmpty();

这个命名是不是非常的蛋疼?根本看不懂这个名字是用来干嘛的,所以使用一个好的命名规范是非常重要的。

一段优秀的代码应该是自解释的,通过简单明了的变量、方法、类的命名可以让代码变得易于理解,提高代码的清晰度、可读性以及美观程度。

写好注释

如果一段代码没有办法做到自解释该怎么办?这个时候就该注释了。注释其实是一种无奈的妥协。

首先,因为注释不需要运行,所以没有常规的办法来测试它。 注释对不对?有没有随着代码变更?这些问题都是写注释需要注意的地方。注释难以维护,这是使用注释带来的最大的麻烦。但是,对于大部分程序员来说,问题还是注释太少,而不是太多。

我们要对关键代码和方法提供明确的注释,注释要准确、必要、清晰。

  1. 准确,错误的注释比没有注释更糟糕。
  2. 必要,多余的注释浪费阅读者的时间。
  3. 清晰,混乱的注释会把代码搞得更乱。

代码片段

有没有看过一个方法 2000 多行?是不是看到这样的代码就感到非常的头痛?或者是一个类写的乱七八糟?构造方法在中间,get/set 方法在成员变量上面等等。

首先,类的属性和方法,一般是一个代码文件的主要组成部分。类的结构,推荐的编码顺序依次 为:

  1. 类的属性;
  2. 构造方法;
  3. 工厂方法;
  4. 其他方法。

按照这样的规范,一个类的方法一目了然,读这样的代码不会像无头苍蝇一样的猜这个是什么方法,那个是什么方法。

其次按顺序使用限定词,在声明一个类、方法或者方法属性时,为了更准确地描述和理解声明的适用场景,我们通常要使用修饰性的关键词。
private final static long serialVersionUID 就没有 private static final long serialVersionUID 来的规范,static 关键字应该在 final 关键字之前。

代码块应该通过空格、缩进、空行进行分割。使用空行来分开同级别的不同代码块。这样可以使得代码变得更加的清晰和明了。

标签:缩进,精进,代码,规范,注释,如何,static,方法
来源: https://www.cnblogs.com/manastudent/p/12264460.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有