History是修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述 。4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等 。
示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内 。/************************************************* Function: // 函数名称 Description: // 函数功能、性能等的描述 Calls: // 被本函数调用的函数清单 Called By: // 调用本函数的函数清单 Table Accessed: // 被访问的表(此项仅对于牵扯到数据库操作的程序) Table Updated: // 被修改的表(此项仅对于牵扯到数据库操作的程序) Input: // 输入参数说明,包括每个参数的作 // 用、取值说明及参数间关系 。
Output: // 对输出参数的说明 。Return: // 函数返回值的说明 Others: // 其它说明*************************************************/5:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性 。
不再有用的注释要删除 。6:注释的内容要清楚、明了,含义准确,防止注释二义性 。
说明:错误的注释不但无益反而有害 。7:避免在注释中使用缩写,特别是非常用缩写 。
说明:在使用缩写时或之前,应对缩写进行必要的说明 。8:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开 。
示例:如下例子不符合规范 。例1:/* get replicate sub system index and net indicator */ repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni; 例2:repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;/* get replicate sub system index and net indicator */ 应如下书写/* get replicate sub system index and net indicator */repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义 。
变量、常量、宏的注释应放在其上方相邻位置或右方 。示例:/* active statistic task number */#define MAX_ACT_TASK_NUMBER 1000#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */10:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释 。
对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方 。示例:可按如下形式说明枚举/数据/联合结构 。
/* sccp interface with sccp user primitive message name */enum SCCP_USER_PRIMITIVE{ N_UNITDATA_IND, /* sccp notify sccp user unit data come */ N_NOTICE_IND, /* sccp notify user the No.7 network can not */ /* transmission this message */ N_UNITDATA_REQ, /* sccp user's unit data transmission request*/};11:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取 。
6. C语言 帮忙写个注释 全一点 谢谢了 #include #include #include void func1();//等级一void func2();//等级二int count1=0,count2=0;//正确个数,错误个数int main(){ srand((unsigned)time(NULL));//设定随机数种子 int n; do { printf("\n欢迎进入打字程序练习\n"); printf("输入1进入一等级,输入2进入二等级,输入3退出程序\n");//屏幕提示菜单 scanf("%d",&n);//用户输入选择 switch(n) { case 1: func1(); break; case 2: func2(); break; } }while(n!=3); printf("谢谢使用本软件,你键入了%d个正确字符,%d个错误字符,再见!!!\n",count1,count2); return 0;}void func1()// 等级一{ int a; char str[10],str1[10];//要求的字符串,用户输入的字符串 for(a=0;a