技术部编码规范.doc

文档介绍：技术部编码规范2002-3-7一、开发环境:开发时操作系统采用widows系列编码采用标准C、C51、汇编中的一种或儿种混合编码;一般情况下以C51为主;编译工具采用Keil公司的KeiluVersion2编译器;编辑工具采用UltraEdit;(在不影响编码规范也可用其它的编辑工具)二、编码规范:1、注释:(1) 注释要简单明了,边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性,在必要的地方注释,注释量要适中。注释的内容要清楚、明了,含义准确,防止注释二义性。(2) 保持注释与其描述的代码相邻,即注释的就近原则,对代码的注释应放在其上方相邻位置或右边,不可放在下而,对数据结构的注释应放在其上方相邻位置,不可放在下血;对结构中的每个域的注释应放在此域的右方;同一结构中不同域的注释要对齐,全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它,以及存取时注意事项等的说明。(3) 采用中文注释,专用术语采用英文或数字;除以下规定的特殊形式的注释外其它的均以“〃”开头,不用“/**/”;(4) 儿种常用注释的示例:A、单元开头的注释:(每个编码单元及相关说明文档都必须有),如:******************************^************************************* CopyRight1995-2002VID0 ***************************************^************^***************:17:00硬适录招机的前面板程序;U78E51,:10:00张永历使用TL中断控制延时2002/07/0209:15:00刘为胜加入对12887的控制*******************^*********^*********************^***#************B、单元内函数、变量的注释:TMOD=0x20;〃定时■器工作于方式二〃启动定时TRO=1;TRI=1;SCON=0x50;〃方式一,8校UART(异步收发);允许串行接收校;//SMO=O,SM1=1ZREN=1ZRI=0zTI=0PCON=0x80;//SHOD=1TL1=Oxfd;〃波特率为19200BpsTH1=Oxfd;//TH1=256-*1066/(16*12*19200)THO=0x06;〃定时25QusTLO=0x06;//ES=1;〃开串口中断|ETO=1;〃开定时器。的中断EA=1;〃开中断P0&=Oxfe;Pl&=0x7f;Pl1=0x80;Pl1=Oxff;P21=Oxff;return1;(!in让_12887())return0;函数名称创建入员函数版本创建日期功能描述入口参数receivecountx *返回值:修改记录::14:00通过串口接收多个字符u_char*c存放接收字符串的指针u~charcount接收的宇符的个数毛***^********************************************