代码规范

    

 

    一、代码规范的优点

    1、促进团队和谐

我们现在几乎不会一个人编写一整个程序了，都需要团队合作，我们写的代码不仅要自己看懂还需要开发小组的其他成员和维护人员能够看懂，所以我们写的代码符合统一的规范有利于我们的团队合作。

    2、减少bug的处理

这个不是减少产生bug的数量，而是出现bug很容易就可以找出是哪里为了问题从而很容易就可以处理这个问题。

    3、降低维护成本

如果开发的时候写的代码很规范，那么维护人员很容易就可以看出一个模块的代码是什么作用，从而维护的工作就会大大减轻。

    4、有助于代码审查

这个应该是写的代码规范了，验收项目的时候代码审查就很容易进行了。

    5、有助于程序员的自身成长

据说写的代码质量直接可以看出一个程序员的素质和能力。

 

    二、一段高质量的代码有什么样的特性

    1、可读性：让别人看自己写的代码，看懂所花费的时间越短越好，也就是理解代码所用的时间越短越好

    2、可维护性：就是出现了问题，在原来代码的基础上修改一下就可以，不用再重新写一遍。

    3、可扩展性：在原来代码的基础上，可以很容易的增加、修改从而实现新的功能。

 

    三、命名规范

    1、把信息放到名字里

    2、使用更有表现力的词

    3、用具体代替抽象

    4、为名字附带更多的信息

    5、长度最好是2~3个单词，字母数在3~30之间

    6、用标识符命名，如一些单词的缩写。例如：stu

    7、用没有歧义的名字（就是这个命名不会被理解出两层含义）

    8、避免和关键词冲突（如base、date）

    9、命名方法  

        Pascal命名法：每个单词的首字母都大写

        Camel命名法：除了第一个单词的首字母小写，别的单词的首字母都大写

 

    四、注释

      1、帮助读者理解

      2、写有价值的注释

      3、公布已有陷阱

      4、全局观的注释

      5、常用注释：单行注释、块注释、头注释、方法注释、其他注释

 

   五、审美

      1、空行规则，尊重空间

      2、把废弃的旧代码删掉

      3、缩进后续行

      4、组织结构养眼

      5、一屏原则（一个模块的代码最好一个屏幕可以放下，这样方便查看代码）

      6、个人风格和一致性

 

   六、异常处理

      1、优雅的错误提示

      2、使用的日志

 

   【总结】代码规范对自己和别人都很有帮助，因为我们的产品不会上线之后就完了，还会有后期的维护工作，我们的开发一个程序也不是一个人开发，所以我们的写的代码不只是我们自己能看懂，还需要让维护人员和开发小组的其他成员也要能看懂，这样后续的工作才能进行。