养成良好的编码习惯.ppt

养成良好的编码习惯 为什么要有编码规范： 编码规范对于程序员而言尤为重要，有以下几个原因：一个软件的生命周期中，80%的花费在于维护。几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护。编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码。如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品。为了执行规范，每个软件开发人员必须一致遵守编码规范。每个人！！！ 不讲规范的编码是垃圾。 对每个文件大小的要求 每个文件如每个java文件（jsp画面由于画面复杂程度不同不在此例） 为了可阅读性 不要超过2000行（包括注释） 对每个类的注释 /* * Classname 类名 * * Version information 版本信息 * * Date 创建或修改时间 * * Copyright notice 版权信息 */ 每一行的长度 不要超过80个字符 当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之：在一个逗号后面断开。在一个操作符前面断开。 断行的例子 断行例子2 注释 Java程序有两类注释：实现注释和文档注释。实现注释是使用/*...*/和//界定的注释。文档注释是Java独有的，并由/**...*/界定。文档注释可以通过javadoc工具转换成HTML文件。 注释量 虽然说频繁的注释有时反映出代码的低质量。 但是在工程中为了尽可能的保证编码质量会有一些硬性要求：比如达到代码量的三分之一以上。也就是一千行代码中应该出现300行以上的注释。 在工程中计算你的工作量时，注释也属于代码量 实现注释的格式 程序可以有4种实现注释的风格：块(block)、单行(single-line)、尾端(trailing)和行末(end-of-line)。 块注释 块注释通常用于提供对文件，方法，数据结构和算法的描述。 单行注释 短注释可以显示在一行内，并与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完，就该采用块注释。单行注释之前应该有一个空行。 尾端注释 极短的注释可以与它们所要描述的代码位于同一行，但是应该有足够的空白来分开代码和注释。 行末注释 注释界定符//，可以注释掉整行或者一行中的一部分。它一般不用于连续多行的注释文本；然而，它可以用来注释掉连续多行的代码段。 文档注释 文档注释描述Java的类、接口、构造器，方法，以及字段(field)。每个文档注释都会被置于注释定界符/**...*/之中，一个注释对应一个类、接口或成员。该注释应位于声明之前 变量的声明 推荐一行一个声明，因为这样以利于写注释。 也就是不要写成int a,b,c; 而是int a; int b; int c; 变量初始化 尽量在声明局部变量的同时初始化。唯一不这么做的理由是变量的初始值依赖于某些先前发生的计算。 也就是如int a = 0;而不是int a;……;a = 0; 变量所放位置 只在代码块的开始处声明变量。 比如在一个类的开始处，函数的开始处，首先声明好变量，而不是把变量东一个西一个的存放。 空白都是代码量 在很多情况下空行将逻辑相关的代码段分隔开，可以提高可读性 ，因此在计算工作量时可以将空行计算在内。 使用空行的情况 下列情况应该总是使用两个空行：一个源文件的两个片段(section)之间类声明和接口声明之间 下列情况应该总是使用一个空行：两个方法之间方法内的局部变量和方法的第一条语句之间块注释或单行注释之前一个方法内的两个逻辑段之间，用以提高可读性 命名规则： 包：全部小写 类，接口：名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词 方法：方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。 变量：第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。 常量：类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开。如： static final int MIN_WIDTH = 4; 另外一些好的编码习惯 如在if(i==2)可以写成if(2==i) If(a==2b2||c3)可以写成 if((a==2)(b2)||(c3)) 一个目的：为了别人阅读起来更加