c语言库函数编程规范要点 c语言程序设计库函数( 五 )


返回值: 0x00正常
异常:exception1异常情况1, exception2异常情况2
********************************************************************/
( 注释后直接开始程序正文,不空行 。)
1.3.5功能性注释嵌在源程序体中,用于描述其后的语句或程序段做什么工作,也就是解释下面要做什么,或是执行了下面的语句会怎么样 。而不要解释下面怎么做,因为解释怎么做常常与程序本身是重复的 。
例:
/*把 amount 加到 total中*/
total = amount + total;
这样的注释仅仅是重复了下面的程序,对于理解它的工作并没有什么作用 。而下面的注释,有助于读者理解 。
/*将每月的销售额amount加到年销售额total中*/
total = amount + total;
1.4 函数编写应尽可能短小精悍,一般不超过两屏 , 以便于调试和理解 。
1.5语句结构
为保证语句结构的清晰和程序的可读性 , 在编写软件程序时应注意以下几个方面的问题:
——在一行内只写一条语句,并采用空格、空行和移行保证清楚的视觉效果 。
——每一个嵌套的函数块,使用一个TAB缩进(可以设定为4个空格),大括号必须放在条件语句的下一行,单独成一行,便于匹对:
如,有一段程序如下:
for(i=1;in-1;i++){ t=1; for(j=i+1;jn;j++){
if(a[j]a[t] ) t=j; if(t!=i ){work=a[t];a[t]=a[I];a[I]=work;}}}
应写为
for( i=1; in-1; i++)
{
t=1;
for(j = i+1; jn; j++)
{
if(a[i]a[j])
t=j;
if(t!=1)
{ .5.
Q/ECC/BJ 010—2001
work=a[t];
a[t]=a[i];
a[i]=work;
}
}
}
——文件之中不得存在无规则的空行,比如说连续十个空行 。
一般来讲函数与函数之间的空行为2-3行;
在函数体内部,在逻辑上独立的两个函数块可适当空行 , 一般为1-2行 。
——程序编写首先应考虑清晰性 , 不要刻意追求技巧性而使得程序难以理解 。
——每行长度尽量避免超过屏幕宽度 , 应不超过80个字符 。
——除非对效率有特殊要求 , 编写程序要作到清晰第一,效率第二 。
——尽可能使用函数库 。
——尽量用公共过程或子程序去代替重复的功能代码段 。要注意,这个代码应具有一个独立的功能,不要只因代码形式一样便将其抽出组成一个公共过程或子程序 。
——使用括号清晰地表达算术表达式和逻辑表达式的运算顺序 。如将 x=a*b/c*d 写成 x=(a*b/c)*d可避免阅读者误解为x=(a*b)/(c*d) 。
——避免不必要的转移 。
——避免采用过于复杂的条件测试 。
——避免过多的循环嵌套和条件嵌套 。
——建议不要使用 *=,^=, /=等运算符 。
——一个函数不要超过200行 。一个文件应避免超过2000行 。
——尽量避免使用go to语句 。
——避免采用多赋值语句,如x = y = z ;
——不鼓励采用?:操作符,如z = (ab)?a:b;
——不要使用空的if else 语句 。如
if(cMychar = ‘A’)
if(cMychar = ‘Z’)
printf(“This is a letter \n”);
else
printf(“This is not a letter \n”);
else到底是否定哪个if容易引起误解 。可通过加{}避免误解 。
——尽量减少使用“否定”条件的条件语句 。如:
把 if( !( (cMychar’0’) || (cMychar’9’) ) )
改为if( (cMychar=’0’)(cMychar=’9’)
C语言中什么是库函数?库函数(Library function)是把函数放到库里,供别人使用的一种方式 。.方法是把一些常用到的函数编完放到一个文件里,供不同的人进行调用 。调用的时候把它所在的文件名用#include加到里面就可以了 。一般是放到lib文件里的 。

推荐阅读