10第七章节程序代码的文档化.pptVIP

3.3 循环语句 多重循环，若可能，应长循环在内，短循环在外 以减少CPU跨切循环层的次数。 循环控制变量采用“半开半闭区间”写法。 即： x介于[0,N) for (int x=0; xN; x++) 而不是 x介于[0,N-1] for (int x=0; x=N-1; x++) 4. 函数设计 函数体的“入口处”和“出口处”把关 4.1 参数 4.2返回值 4.1 参数的规则 参数写完整、命名恰当、顺序合理 StringCopy(char *str1, char *str2) 类型和参数名都要写 参为指针，若仅传入数据，则加const 参数个数5个 4.2 返回值的规则 返回值类型别省略。 正常值——输出参数获得 错误标志——用return返回 为增加灵活性支持链式表达，可附加返回值 char *strcpy(char *strDest，const char *strSrc); 明确说明用于出错处理的返回值 让使用者不容易忽视或误解错误情况 4. 函数设计一些建议 函数的功能要单一 函数体50行 检查所有进入函数体的变量的有效性， 1）输入参数 2）通过其他途径进入函数体内的变量 如全局变量、文件句柄等。 4.5 使用断言 使用断言捕捉不应该发生的非法情况。 如：函数入口处，用断言检查参数的有效性。 void *me