C语言编程规范可读性要求.docxVIP

C语言编程规范 可读性要求 1、 说明 每个源程序文件，都有文件头说明 每个函数，都有函数头说明 文件头说明范例： /************************************************* 文件名：sp8302. c *功能描述：柜员凭证查询 * *作 者：jane *完成日期：2003年4月12日 * *修改记录： *日期：2003年4月25 H *修改人：jane *修改内容：此交易只允许上级机构査询下级机构，不能垮管理査询, * 网点间不能互查，同一网点柜员间可以互查； *************************************************/ 函数头说明范例： /********************************************************************** * 函数名： 函数功能： 作者/时间: pub base CrtAcChkb生成账号校验位 2003 年 12 月 16 口 XXX 参数： 输入: acno int mode chkb len :无校验的账号 :帐号介质（1客户帐号2内部帐号3卡帐号4客户号） :校验位的长度 输出: chkb acno :带校验位的帐号 回值: 0成功，1失败 修改历史: * ********************************************************************/ 做好事要留名，注意备份 修改程序必须注明的要素：谁何时因何种原因修改那部分的代码，并且注意 备份修改之前的程序 2、 注释 尽量使用/*注释内容*/格式，不要使用//格式 保持注释与代码完全一致。 对单行代码的注释可以在代码的上方和代码的后面； 对多行代码的注释应该放在代码的上方； 例1. int head_flag - 0 ; /***added bye liuyue在处理6*科目的时候因为有的支行该类科目都为 0,导致了打印时候不打表头的情况***/ 例2. /*打印下级科目有金额的上级科目added by martin */ if( !pub_base_CompDblVal(s_gl bal, 0. 00) !pub_base_CompDblVal(s_gl bal, 0. 00) !pub_base_CompDblVal(s_gl bal, 0. 00) !pub_base_CompDb1Va1(s_gl bal, 0. 00) !pub_base_CompDblVal(s_gl amt, 0. 00) !pub_base_CompDb1Vai(s_gl amt, 0. 00)) ( memset(sGl_sub, 0x00, sizeof(struct gl_sub_c)); meniset (s_com_item, 0x00, sizeof (struct com_item_c)); ret - Com_item_Sel( g_pub_tx. reply, s_com_item, 〃acc_hrt=％s〃， s_gl_hrt ); pub_base_strpack( s_com no ); if( strlen(s_com no)==7 ) { continue; )else( ret=Gl_sub Sei( g_pub_tx. reply , sGl_sub , br_no=%s‘ and cur_n。二01 and acc_hrt like \ and (rdd_amt0 or rcd_amt0 or dr_bal0 or cr_bal0 or ldd_bal0 or lcd_bal0)* , s_gl no, s_com no); if( ret==100 ) continue; 主要变量(结构、联合、类或对象)定义或引用时，注释能反映其含义。 常量定义(DEFINE)有相应说明。 处理过程的每个阶段都有相关注释说明。 在典型算法前都有注释。 例3. /********************************************************************** 函数名： pub_base_GetDate *函数功能： 取得系统日期 *作 者： *完成时间：2003年12月16日 * *参 数： 输入：无 * 输出：year： 年 month：月 day: 日 * 返回值：无 * *修改历史： * ********************************************************************/ void pub_base_GetDate(int *ye