新型人机交互实验室 编程手册.pdf

新型人机交互实验室 C 与C++编程手册 教程与规范 新型人机交互实验室 2011/9/17 本手册为新型人机交互实验室内部C 与C++编程手册，主要包含代码规范、文档规范、 所需工具的简单介绍和教程。 目录 导读1 一、代码规范2 1.1 概述2 1.2 命名规则3 1.3 代码排版6 1.3.1 缩进6 1.3.2 换行7 1.3.3 空格9 1.4 代码结构与代码质量11 1.5 示例11 二、注释与文档规范12 2.1 概述12 2.2 Doxygen：自动化文档生成工具12 2.3 注释原则13 2.4 注释规范14 2.4.1 注释块14 2.4.2 注释中的特殊指令和HTML 指令17 2.5 示例20 三、版本控制21 概述21 跨平台的自动化建构25 概述27 基于Linux 的解决方案28 概述28 导读 本手册为新型人机交互实验室内部C 与C++编程手册，主要包含代码规范、文档规范、 所需工具的简单介绍和教程。 团队项目的良好运行需要有良好的规范和制度作为保障，本手册结合实验室情况，做出 基本的规范，并引入一些提高开发效率的工具。良好的编程习惯有利于提高个人和团队效率， 利于代码的维护和复用，辅助工具的使用可以帮助我们更好的进行项目的管理。 考虑到实验室成员的知识背景，本手册以目前使用最多的Windows 系统和Visual Studio 为背景，给出代码和文档基本规范，以及一系列工具的简单介绍和基本教程。本手册针对一 般性编程工作，包括如基于OpenCV 的算法实现，基于Qt 的应用开发等。另外，如MFC 等 已有代码风格标准（匈牙利命名法）的相关工作，使用者可结合自身情况进行取舍，代码不 同逻辑模块使用不同代码风格，或统一使用一种风格。 本手册内容难度从基本到进阶，代码规范和文档规范为必选部分，实际项目中必须依照 这两部分进行；后续工具的教程为可选部分，可以在项目的实践中学习和应用。 各个部分简介在下面列出： 一、代码规范：主要做出一般性C 与C++代码规范，主要包括命名规则与代码排版规则； 二、注释与文档规范：基于Doxygen 的注释与自动化文档； 三、版本控制：基于Mercurial （TortoiseHg ）的版本控制； 四、跨平台的自动化建构：基于CMake 的项目组织； 五、基于Linux 的解决方案：将工作平台迁移至Linux 系统。 1 一、代码规范 1.1 概述 良好的代码风格是编程者必须的素养，每个编程者在多年编程经验后都会有一套自己的 代码风格。团队项目必须确定一种代码风格作为统一的代码规范，本部分给出本实验室 C 与C++的代码规范。 本套规范基于流行的C++代码风格，以简单易学为主旨，其总纲如下： 1. 命名规则：一般命名使用驼峰法，即每个单词之间以首字母大写，其它字母小写作 为区分 1) 一般变量名、函数名首字母小写； 2) 类、结构体、枚举等自定义类型命名首字母大写； 3) 类的私有成员名称前加下划线； 4) 文件名首字母大写； 5) 宏定义全部使用大写，下划线分割。 2. 排版规则 1) 统一使用4 个空格作为缩进，不使用tab 缩进； 2) 每行只定义一个变量，并进行初始化； 3) 换行规则 a) 类、结构体、枚举、函数等区块定义之间加一个空行进