源程序文档化.pptxVIP

软件工程研讨 源程序文档化;变量、常量和函数的命名规范;变量名所有字母小写，单词之间用下划线(_)分开，类成员变量以下划线结束。 普通变量命名(Common Variable Names) 比如：;结构体成员变量命名(Struct Variables) 结构体成员变量和普通变量命名规则一致，且不像类 成员变量以下划线结束。 ;常量命名(Constant Names);函数命名(Function Names);访问器和修改器(Accessors and Mutators) 访问器和修改器（get和set函数）应该与它们关联的变量名匹配。下面显示了一个类的部分摘录，它有一个实例变量num_entries;对文件、类、函数、变量和逻辑功能段进行注释的规范; 文件注释(File Comments);文件内容注释(File Contents) 每个文件都应该在其版权信息及作者信息后面和内容前面有一个内容描述性的注释。 通常，头文件描述它所声明的类的目的及用法。而源文件则应该包含更多有关实现和技巧性算法的讨论信息。但如果你觉得这些信息对于头文件的阅读者更有用，可以将其放在头文件中，但在源文件中应该注明其文档在头文件中。不要在头文件和源文件中重复注释，这样容易造成歧义。;类注释(Class Comments);函数注释(Function Comments);例子：;当给构造和析构函数加注释时，注