(2013.10.11)C++语言程序设计课程教学研讨（文本）.doc

（2013.10.11）C++语言程序设计课程教学研讨（文本） 王娇： C++语言程序设计的各位老师，下午好，欢迎参加今天的网上教学研讨。 所有程序开发者需要注意的一点是——编码的规范性。面授教学时，教师怎么强调规范都不为过。在此介绍规范程序的书写。 一、文件头 所有C++的源文件均必须包含一个规范的文件头，文件头包含了该文件的名称、功能概述、作者、版权和版本历史信息等内容。标准文件头的格式为： /*! @file ******************************************************************************** 模块名 : 文件所属的模块名称 文件名 : 文件名 相关文件 : 与此文件相关的其它文件 文件实现功能 : 描述该文件实现的主要功能 作者 : 作者部门和姓名 版本 : 当前版本号 -------------------------------------------------------------------------------- 多线程安全性 : 是/否[，说明] 异常时安全性 : 是/否[，说明] -------------------------------------------------------------------------------- 备注 : 其它说明 -------------------------------------------------------------------------------- 修改记录 : 日 期 版本 修改人 修改内容 YYYY/MM/DD X.Y 作者或修改者名 修改内容 *******************************************************************************/ 每行注释的长度都不应该超过80个半角字符。还要注意缩进和对齐，以利阅读。 二、命名规范 一套定义良好并且在整个项目中统一使用的命名规范将大大提升源代码的可读性和软件的可维护性。命名规范的整体原则有： 1．同一性：在编写一个子模块或派生类的时候，要遵循其基类或整体模块的命名风格，保持命名风格在整个模块中的同一性。 2．标识符组成：标识符采用英文单词或其组合，应当直观且可以拼读，可望文知意，用词应当准确。 3．避免过于相似：不要出现仅靠大小写区分的相似的标识符，例如“i”与“I”，“function”与“Function”等等。 4．避免在不同级别的作用域中重名：程序中不要出现名字完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生语法错误，但容易使人误解。 5．避免名字中出现数字编号：尽量避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号。这是因为数字编号往往是无意义的名字。 函数的命名规范举例： 1． 函数的名称由一个或多个单词组成。为便于界定，每个单词的首字母要大写。 2．推荐的组成形式：函数名使用动词或者动词＋名词（动宾词组）的形式。例如：GetName(), SetValue(), Erase(), Reserve() 3．保护成员函数：保护成员函数的开头加上一个下划线“_”以示区别，例如：_SetState() 4．私有成员函数：私有成员函数的开头加上两个下划线“__”，例如：__DestroyImp() 5．回调和事件处理函数： 回调和事件处理函数习惯以单词“On”开头。例如：_OnTimer(), OnExit() 6．虚函数： 回调函数以外的虚函数习惯以“Do”开头，如：DoRefresh() 变量的命名规范举例： 变量名由作用域前缀＋类型前缀＋一个或多个单词组成。为便于界定，每个单词的首字母要大写。 对于某些用途简单明了的局部变量，也可以使用简化的方式，如：i, j, k, x, y, z .... 作用域前缀标明一个变量的可见范围。除非不得已，否则应该尽可能少使用全局变量。作用域可以有如下几种： 前缀 说明 无 局部变量 m_ 类的成员变量（member） sm_ 类的静态成员变量（static member） s_ 静态变量（static） g_ 外部全局变量（global） sg_ 静态全局变量（stat