软件代码规范之理解

 

首先，代码规范是让大家统一风格。就一种语言来说，它的编码规范例如：缩进，命名，文件结构，注释风格等，如果它们都能统一，那么，对于你熟悉的一门语言，无论是你自己写的，还是你同事写的，甚至是其他公司的人员写的，你都能很轻松的阅读任意一段代码，并轻易的看懂它们。我就对我比较熟悉的JAVA代码规范做以下几点总结:

1.变量命名

对于变量、数组、方法/函数、类和对象，如何规范地进行命名至关重要，尤其是当程序规模扩大，变量数量激增的情况下。我们常用的命名法有：匈利亚命名法、驼峰命名法、下划线命名法(这里就不做详细介绍，只对我使用的JAVA的驼峰命名法做简单介绍)

• 采用有意义的英文单词或缩写，不推荐使用拼音、无意义单词、单个字母、数字编号
• 变量由多个英文单词构成，不间隔下划线、短横线、点号或者其他符号
• 第一个单词全部小写，从第二个单词开始，首字母大写，以断开每个单词

2.缩进和换行

缩进与换行可以增强代码的可读性。

缩进的原则：

• 如果前一行是左大括号（“花括号”{），一般这一行就要相对括号的位置缩进一个单位。
• 如果前一行为if，for，while、else、do，而下一行不是花括号，则下一行必须缩进。
• 缩进使用Tab键（位于键盘上Q的左侧），而不应使用空格。这样不仅便利，而且可以达到距离的统一，空格的数目难以控制，且无法被编辑器识别为缩进。

换行的原则：

• 在分号之后换行
• 在表示结构块的大括号之后换行：{ 换行 换行 } 换行
• if，for，while、else、do之后换行

3.空行

空行起到划分区域的作用，这使代码阅读起来更加容易，能够一眼看出代码由哪几个部分组成。

4.括号

括号对于代码书写的正确性至关重要。为确保括号成对不至于缺失，可以采用下面的方法：

　　方法一：每次书写括号时同时写下一对括号，这样就不存在忘记写末尾括号的问题了;

　　方法二：使用IDE的括号匹配和自动完成功能，在Eclipse中，只要写下一个括号，程序就能自动补全另一半，非常便利.

5.注释

注释能够帮助程序被更好的理解，因此清晰、简洁、明白的注释是良好代码风格的体现。

注释传达的信息包括：

• 开头介绍代码的作者、日期、版本
• 介绍各部分各自的作用
• 介绍解决问题的过程