上海大学软件工程研讨精要.pptxVIP

软件工程研讨 3、源程序文档化;变量、常量和函数的命名规范;变量名所有字母小写，单词之间用下划线(_)分开，类成员变量以下划线结束。 普通变量命名(Common Variable Names) 比如：;结构体成员变量命名(Struct Variables) 结构体成员变量和普通变量命名规则一致，且不像类 成员变量以下划线结束。 ;常量命名(Constant Names);函数命名(Function Names);访问器和修改器(Accessors and Mutators) 访问器和修改器（get和set函数）应该与它们关联的变量名匹配。下面显示了一个类的部分摘录，它有一个实例变量num_entries;对文件、类、函数、变量和逻辑功能段进行注释的规范; 文件注释(File Comments);文件内容注释(File Contents) 每个文件都应该在其版权信息及作者信息后面和内容前面有一个内容描述性的注释。 通常，头文件描述它所声明的类的目的及用法。而源文件则应该包含更多有关实现和技巧性算法的讨论信息。但如果你觉得这些信息对于头文件的阅读者更有用，可以将其放在头文件中，但在源文件中应该注明其文档在头文件中。不要在头文件和源文件中重复注释，这样容易造成歧义。;类注释(Class Comments);函数注释(Function Comments);例子：;当给构造和析构函数加注释时，注意，读者清楚地知道这些函数的作用，所以诸如“销毁这个对象”的注释毫无意义。注释内容应该说明构造函数怎样处理参数（比如它是否取得指针的控制权）和析构函数怎么完成清理工作。如果这些不很重要，可以省略它们。文件的开头注释中没有关于析构函数的注释是很正常的。;变量注释(Variable Comments);全局变量(Global Variables) 和数据成员一样，所有全局变量应该有一个描述其功能及其意义的注释。比如;行注释(Line Comments) 同样，当行代码中有不明显的地方时，也需要在其行末添加注释。这种行末注释应该以2个空白与代码分开。;逻辑功能段进行注释;也可以使用替代方案，常量或自描述的变量：;函数声明和定义、函数调用、条件语句、循环语句和类的格式规范;函数声明与定义(Function Declarations and Definitions);也可以每个参数各占一行：;需要注意的地方： 返回类型应该保持与函数名在同一行； 左括号应该与函数名保持在同一行且中??不应该有空格； 括号与参数之间不应该有空格； 左花括号应该与最后一个参数保持在同一行； 右花括号要么独自一行，要么与左花括号保持在同一行（其他风格规则允许时）； 右圆括号与左花括号之间应该有一个空格隔开； 无论是函数声明还是函数实现，都应该给参数命以同样的名称； 默认缩进2个空格； 分行的参数以4个空格缩进；;定义const函数时，const关键字应该与最后一个参数保持在同一行。;如果有未使用参数，在函数实现中注释其名称：;函数调用(Function Calls);如果参数签名太长，超过最大行宽，可以将参数分行写书：;条件语句(Conditonals);当然，你也可以根据自己的喜好在括号内插入空格; 为便于阅读，简短的条件语句可以写在同一行。但仅限于这行代码很明确且没有else分支的情况：;为保持一致，if或者else分支加了花括号，另一分支也应该加上。;循环和多分支语句(Loops and Switch Statements);空循环体应该用{}或者continue，但不要用单独的分号：;类格式(Class Format);注意： 基类名称直接置于子类名称后的同一行内而不受最大长度（80字符）的限制； public::protected::和private::只需缩进1个空格，且除非是第1个实例的情况，它们应该位于单独的行，最好在紧接着的下一行进行成员声明； public部分行1位、protected部分第2位，private放在最后；;THANK YOU!