软件编码风格.pptVIP

2、 文件风格 2.2 文件头部注释 文件头部注释主要是表明该文件的一些信息，其格式如下： //////////////////////////////////////////////////////////////////////// /////////// //文件名： //创建者： //创建时间： //内容描述（包括功能，目的，主要算法等）： /////////// //////////////////////////////////////////////////////////////////////// 2、 文件风格 2.3 空行约定 文件之中不得存在无规则的空行，比如说连续十个空行，一般来讲函数与函数之间的空行为2-3行，在函数体内部，在逻辑上独立的两个函数块可适当空行，一般为1-2行。 2、 文件风格 2.4 文件规格化功能键 源文件在编写完毕时，VisualC++提供Alt+F8功能键，进行文件规格化，常使用该按键可使得文件保持规格化（注，Alt+F8功能键对连续两个CASE语句则会发生处理错误，不能规格化）。 3、 函数风格 3.1 模块化 某一功能，如果重复实现三遍以上，即应考虑模块化，将它写成通用函数。并向小组成员发布。同时已要尽可能利用其它人的现成模块。模块化的一些注意事项： （1）设计好模块接口，即是罗列出一个模块的所有的与外部打交道的变量、函数等。用面向对象的观点看，包括：函数接口和变量接口。 （2）定义好接口以后不要轻易改动，并在模块开头（文件的开头或函数的开头）加以说明。 （3）不要在外部使用接口以外的其它函数或变量。 （4）注意全局变量也是一种接口。 （5）利用信息隐蔽，确保每一个模块的独立性。 3、 函数风格 3.2 函数注释 ClassWizard自动生成的函数，如消息响应函数，则不必太多的注释和解释；对于自行编写的函数，若是系统关键函数，则必须在函数实现部分的上方标明该函数的信息，格式如下： //////////////////////////////////////////////////////////////////////// /////////// //函数名： //编写者： //参考资料： //功能： //输入参数： //输出参数： //备注： /////////// //////////////////////////////////////////////////////////////////////// 3、 函数风格 3.3 代码缩进 每一个嵌套的函数块，使用一个TAB缩进（设定为4个空格），大括号必须放在条件语句的下一行，单独成一行，便于匹对： if(condition1) { while(condition2) { } } 3、 函数风格 3.4 语句结构 在可以保持程序的可读性的情况下，不要使用goto语句。 已经证明：任何单入口单出口的没有“死循环”的程序都能由“顺序结构”“IF—ELSE选择结构”和“DO—WHILE重复结构”这三种最基本的控制结构构造出来。在一般情况下，可以完全不使用goto语句。如果非使用不可，要注意以下条件： 程序只有一个入口一个出口 最多用一个goto的标号（labels） 使用goto，应使程序向下执行，而不是向上。 确信不会因使用goto语句而产生无法执行到的代码（Unreachable Code） 3、 函数风格 使用Tab键来对齐代码，其长度统一设为4个字符。 对要用到的常量尽量使用宏定义，对宏定义使用大写字母，并加下划线。 #define MY_MACRO_NUMBER 100 #define MY_MAX_LENGTH 1024 要使用花括号使程序结构更为清晰，即使是一行代码。 if (m_fInitialized) { receiveMessage.length = MY_MAX_LENGTH; } 3、 函数风格 3.5 错误处理 编程中要考虑函数的各种执行情况，尽可能处理所有流程情况。 将函数分两类： 一类为与屏幕的显示无关， 二类为与屏幕的显示有关。 对于与屏幕显示无关的函数，函数通过返回值来报告错误。 对于与屏幕显示有关的函数，函数要负责向用户发出警告，并进行错误处理。 错误处理代码一般放在函数末尾。对于通用的错误处理，可建立通用的错误处理函数，处理常见的通用的错误。 4、 变量风格 什么是匈牙利命名法？ 匈牙利命名法(Hungariannaming)，是国际日趋流行的一种命名标准，其基本原则非常简单。名字由两部分构成：类(Type)和限定词(Qualifier)。类好比是我们名字的姓，而