【项目管理】代码风格规范

代码风格规范

——逗比妍喆和她的小伙伴们组成的小组

1. 命名格式

所有命名均使用英文词语或其缩写

1.1 文件名

    ·文件名与其包含的类名相同，并全部使用小写字母。

1.2 变量、函数名

    ·较小规模的函数内，在含义十分清楚的情况下，可以使用i、j、t等简短的变量名; 含义不明时，如使用简短变量名，应加注释说明。

    ·变量名称可以用大写字母区分单词，例如errorMessage。

    ·函数命名尽可能表达清楚的含义.除了含义十分清楚的函数，其余都应写注释说明。

    ·函数命名以小写字母开头，以大写字母区分不同单词，例如thisIsAFunction。

    ·类名、结构体名以大写字母开头。

    ·不使用匈牙利命名法，如mb_run()

2. 宏定义

    ·全部使用大写字母。

    ·在头文件里使用#ifndef XXX、#define XXX的格式，而不使用#pragma once。

3. 括号、逗号及运算符

    ·大括号一律使用如下格式:

        int plus(int x, int y)

        {

            return x + y;

        }

    ·if、for等与小括号之间有空格

    ·运算符两端有空格

    ·逗号右侧有空格

4. 注释

    ·单一语句的注释在后面使用双斜线

    ·函数内代码段的注释在代码段前使用双斜线<