欢迎来到天天文库
浏览记录
ID：56205714
大小：59.50 KB
页数：8页
时间：2020-03-20
《代码编写规范.doc》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。
1、代码编写规范一、排版规范1．程序块要采用缩进风格编写，缩进的空格以统一的开发工具为准。函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。2．较长的语句（>100字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要警醒适当的缩进，是排版整齐，语句可读。3．不允许把多个短语句写在一行中，即一行只写一条语句。示例:如下例子为不符合规范rng.Font.Size=10;rng.Font.Name="宋体";应如下书写rng.Font.Size=11;rng.Font.Name="宋体";4．If、for、do、whil
2、e、case、switch、default等语句自占一行，且If、for、do、while等语句的执行语句部分无论多少都要加括号{}。示例：如下例子不符合规范If（Strtxt==NULL）return；应如下书写If（Strtxt==NULL）{return；}5．程序块的分界符（如C++/C#语言中的‘{’和‘}’）应各自独占一行并且位于同一列，同时与引用它们的语句左对齐。示例：如下例子不符合规范For（……）{……//programcode}If（……）{……//programcode}应如下书写For（……）{……//programcode}If（……）{……//p
3、rogramcode}一、注释规范1．模块（类）注释规范/// ///模块编号：<模块编号，可以引用系统设计中的模块编号> ///作用：<对此类的描述，可以引用系统设计中的描述> ///作者：作者中文名 ///编写日期：<模块创建日期，格式：YYYY-MM-DD> ///如果模块有修改，则每次修改必须添加以下注释： /// ///Log编号： ///修改描述：<对此修改的描述>
4、 ///作者：修改者中文名 ///修改日期：<模块修改日期，格式：YYYY-MM-DD> /// 1．类属性注释规范 /// ///属性说明///2．方法（函数）注释规范 /// ///说明：<对该方法的说明> /// ///"><参数说明> /// ///<对方法返回
5、值的说明，该说明必须明确说明返回的值代表什么含义> /// 3．代码间注释规范单行注释：//<单行注释>多行注释： /*多行注释1 多行注释2 多行注释3*/代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须能够说明此语句块的作用和实现手段（所用算法等等）。4．边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。5．注释的内容要清楚、明了，含义准确，防止注释二义性。6．对于所有物理含义的变量、常量，如果其命名不是充分自注释的
6、，在声明时都必须加以注释，说明其物理含义。变量、常量的注释应放在其上方相邻位置或右方。1．注释与所描述内容进行同样的缩排。示例：如下例子不符合规范VoidExampleFun（void）{//codeonecommentsCodeBlockone//codetwocommentsCodeBlock}应改为如下布局VoidExampleFun（void）{//codeonecommentsCodeBlockone//codetwocommentsCodeBlock}2．避免在同一行代码或表达式中间插入注释一、标识符命名规范1．变量命名规则。变量的命名要清晰、明了，有明确含义，
7、同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。变量命名：成员变量： m_局部变量：以小写字母开头·类、属性及方法：以大写字母开头，后续单词首字母大写 参考实例：initBorderColor(局部成员变量)、voteNum(局部变量)，程序员可根据实际情况梢做改动，能够使其他程序员看变量名便知其类型和属性等关键标识符意义；2．控件命名规范。控件命名规则一般为前缀+字段名。示例：字段Title，在界面中的控件为textbox命名为txtTitle下列为各种控件所统一的前缀标准控件1bt
此文档下载收益归作者所有
