代码技术第02章.ppt

第2章 养成良好的注释习惯 不同的人在编写程序是总会有不同的思路，因此在阅读别人的复杂代码时，常常存在理解上的障碍。当然，如果时间久了，有时连自己的代码都不一定能看得懂。为代码添加注释可以提高效率，提高代码的可读性，便于团队合作，同时也可以增强代码的逻辑性! 本章要点： 1 注释的用途 2 普通注释的格式 3 正确使用XML文档注释 2.1 注释的用途 计算机语言与人类自然语言之间存在着不小的差距。从最基本的需要来说，注释是为了填补这两者之间的空白，起到一个思维连接的作用。 使得注释存在的最为关键的原因是：人类进行程序设计与程序代码本身并不在同一个逻辑思维层面上。人们思维的时候是“任务式”的，而程序代码则必须是“过程式”的。注释用来体现人们的设计意图。 2.1.1 解释代码的意图 代码本身已经非常详尽地体现出它将如何工作，因此注释起到的应该是一种思维抽象的作用，通过符合人类思维方式的描述性文字从更高的思维层次阐释细节代码的功能与意图。 下面我们分析一个代码段： 分析代码2-1： public int[] randomArray(int x) { int i, rInt, tmp; //创建三个整形变量 Random r1 = new Random(); //创建一个随机数类的对象 int[] randArray = new int[x]; for (i = 0; i x; i++) { randArray[i] = i; } for (i = x - 1; i = 1; i--) { rInt = r1.Next(i); //取出一个0~i范围之内的随机整数赋给rInt //下面是将第rInt个数值与第i个数值交换 tmp = randArray[i]; randArray[i] = randArray[rInt]; randArray[rInt] = tmp; } return randArray; //将计算之后的数组返回出去 } 分析代码2-1： //函数功能：得到一个具有X个元素的随机序列， //数组的元素值为0~x-1，并且不重复 public int[] randomArray(int x) { int i, rInt, tmp; Random r1 = new Random(); //创建一个随机数类的对象 int[] randArray = new int[x]; //为数组赋初值为0，1，2，…，x-1 for (i = 0; i x; i++) { randArray[i] = i; } //循环得到随机值，并与最后一个数值交换 for (i = x - 1; i = 1; i--) { rInt = r1.Next(i); //下面是将第rInt个数值与第i个数值交换 tmp = randArray[i]; randArray[i] = randArray[rInt]; randArray[rInt] = tmp; } return randArray; } 2.1.2 ?对局部变量的说明 （1）如果变量的名称本身无法非常清晰地体现它的所有含义，就需要通过注释来进行说明。当然，如果变量名称所表达的信息已经非常完备（如SqlStr），那么则可以不需要通过注释加以重复。 （2）对于不能确定范围的变量的取值范围，应给与注释。 （3）对于数据所使用的数量单位，应给与注释。 int UserAge; //用户年龄，取值范围0-120，单位岁 double UserHeight; //用户身高，取值范围0-3，单位米 double UserWeight ; //用户体重，单位公斤 double UserScore; //用户评价，取值范围0-5，5为优秀，0为差 2.1.3 ?充当代码标题 注释的另一个常见的用途是以类似小标题的方式对代码进行提纲契领地描述。通过注