C++命名规则&书写规范

简介: C++命名规则&书写规范

常见命名法:


匈牙利命名法:基本原则是:变 量 名 = 属 性 + 类 型 + 对 象 描 述 \color{blue}{变量名=属性+类型+对象描述}变量名=属性+类型+对象描述,其中每一对象的名称都要求有明确含义,可以取对象名字全称或名字的一部分。命名要基于容易记忆容易理解的原则。保证名字的连贯性是非常重要的。


Camel命名法:即骆驼式命名法,原因是采用该命名法的名称看起来就像骆驼的驼峰一样高低起伏。Camel命名法有两种形式:混 合 使 用 大 小 写 字 母 和 单 词 之 间 加 下 划 线 \color{blue}{混合使用大小写字母和单词之间加下划线}混合使用大小写字母和单词之间加下划线,例如runFast和run_fast都属于Camel命名法。


Pascal命名法:与Camel命名法类似,不过Pascal命名法的首字母为大写字母。


命名通则:


1、在所有命名中,都应使用标准的英 文 单 词 或 缩 写 \color{blue}{英文单词或缩写}英文单词或缩写。不得使用拼音或拼音缩写,除非该名字描述的是中文特有的内容,如半角、全角, 声母、韵母等。


2、所有命名都应遵循望文知义原则,即名称应含义清晰、明确。 3、所有命名都不易过长,应控制在规定的最大长度以内。


4、所有命名都应尽量使用全称。


5、如果命名使用缩写,则应该使用《 通 用 缩 写 表 》 ( 见 附 录 ) \color{blue}{《通用缩写表》(见附录)}《通用缩写表》(见附录)中的缩写;原则上不推荐使用《通用缩写表》以外的缩写,如果使用,则必须对其进行注释和说明。


个人整合的具体规范:


1、工程名&命名空间:


工程名不强制统一。

命名空间成员名一律小写,最好使用一个单词或者一个缩写。


2、文件名:


  • 基于工程名,开 头 3 个 字 母 应 表 明 与 哪 一 个 工 程 相 关 \color{blue}{开头3个字母应表明与哪一个工程相关}开头3个字母应表明与哪一个工程相关。 ·后面的字母应能够区别不同的功能。


  • 文件名的每 个 单 词 首 字 母 均 大 写 \color{blue}{每个单词首字母均大写}每个单词首字母均大写长度不限于8.3格式,建 议 不 多 于 30 个 字 符 \color{blue}{建议不多于30个字符}建议不多于30个字符。


  • 若 文 件 用 于 定 义 和 实 现 类 , 建 议 文 件 名 与 类 名 保 持 一 致 \color{blue}{若文件用于定义和实现类,建议文件名与类名保持一致}若文件用于定义和实现类,建议文件名与类名保持一致。


3、函数名:


参照 Windows API 的命名规范。


  • 推 荐 使 用 动 宾 结 构 。 \color{blue}{推荐使用动宾结构。}推荐使用动宾结构。函数名应清晰反映函数的功能、用途。


  • 函数名最长不得超过30个字符。


  • 函 数 名 第 一 个 字 母 必 须 大 写 , 单 词 与 单 词 之 间 使 用 \color{blue}{函数名第一个字母必须大写,单词与单词之间使用}函数名第一个字母必须大写,单词与单词之间使用,下 划 线 来 分 割 。 \color{red}{下划线来分割。}下划线来分割。


全 局 函 数 必 须 以 小 写 前 缀 " g " 开 头 \color{blue}{全局函数必须以小写前缀"g"开头}全局函数必须以小写前缀"g"开头。


void g_Url_name ();
void Url_name ();


4、变量名:


原则上,变量名的命名遵从匈牙利记法。即:前缀 + 类型 + 变量名(变量名称需要名词开头,不应该动词开头)

格式:

[m_|s_|g_] type [class name|struct name] variable name


解释:


前缀


·m_ : 类的成员变量

·ms_:类的静态成员变量

·s_ :静态全局变量

·g_ :普通全局变量


类型缩写(type)


·char, TCHAR: ch
·char[],TCHAR[]: sz
·string: str
·bool, BOOL: b
·int, __int16,__int32,__int64: n
·long: l
·double: d
·float: f
·BYTE: by
·WORD: w
·DWORD: dw
·unsigned: u
·function: fn
·pointer :p
·long pointer :lp


  • 变量名最长不得超过20个字符。


int m_n_name = 0;//在.h文件中申明的变量
int _n_name = 0;//局部的变量


5、类名:


必须以大写"C"开头,后面字母反映具体含义,以清晰表达类的用途和功能为原则。

接口必须以大写"I"开头,代表 Interface 。

当名称由多个单词构成时,每一个单词的第一个字母必须大写。


class IShape{
public:
    virtual int __fastcall ifunc() = 0;
};
// 派生类
class CUrlTable : public IShape
{}


6、结构体名、宏名、枚举名、联合名:


  • 全部大写。
  • 枚举名加小写前缀"enum"。例:


typedef enum _CFILE_OPEN_MODE { 
 enumOPEN_READONLY = 0, 
 enumOPEN_READWRITE = 1, 
 enumCREATE_ALWAY = 3 
 } CFILE_OPEN_MODE; //


宏名加小写前缀"def"。


例:

#define defMAXNUMBER 100
1
结构名加小写前缀"tag",之后必须以大写"C"开头。例:
 typedef struct tagKPOINT {
   int x;
   int y; 
   } KPOINT; 
//·联合名加小写前缀"uni"。 
typedef union _VARIANT{ 
  char unichVal; 
  int uninVal; 
  long unilVal; 
  float uniftVal;
} VARIANT;


C/C++源代码书写规范


  • 在.h/.cpp的开头应有一段格式统一的说明,内容包括:


a. 文件名 (FileName);

b. 简短说明文件功能、用途 (Comment);

c. 创建人 (Creater);

d.文件创建时间 (Date)。


例:


/*!
  *@file
  *@brief
  *@author
  *@date
  */


  • 除非极其简单,否则对函数应有注释说明。内容包括:功能、入口/出口参数,必要时还可有备注或补充说明。


  • 每行代码的长度推荐为80列,最长不得超过120列;折行以对齐为准。


/

HANDLE CSOpenFile(
const char cszFileName[];
int nMode;
);
//或者:
BOOL CSReadFile(
HANDLE hFile;
void *pvBuffer;
int nReadSize;
int *pnReadSize;
);


  • 循环、分支代码,判断条件与执行代码不得在同一行上。


//正确:
if (n == -2)
    n = 1;
else
    n = 2;
//不得写做:
if (n == -2) n = 1;
else n = 2;


  • 指针的定义,* 号既可以紧接类型,也可以在变量名之前。


int* pnsize; //可写,最好不要
int *pnsize; //可写
int * pnsize; //不可写


  • 在类的成员函数内调用非成员函数时,在非成员函数名前必须加上“::”。


  • 函数入口参数有缺省值时,应注释说明。


/

BOOL KSSaveToFile(const char cszFileName[],BOOL bCanReplace /* = TRUE */);
//或者:
BOOL KSSaveToFile(const char cszFileName[],BOOL bCanReplace // = TRUE );


  • else if 必须写在一行。


与‘{’、‘}’有关的各项规定:


  • ‘{’、‘}’应独占一行。在该行内可有注释。


//正确:
for (i = 0; i < cbLine; i++)
{ // .....
    printf("Line %d:", i);
    printf("%s\n", pFileLines);
}
//不得写做
for (i = 0; i < cb; i++)
{printf("Line %d:", i);
printf("%s\n", pFileLines);}


  • ‘{’必须另起一行,‘{’之后的代码必须缩进一个Tab。‘{’与‘}’必须在同一列上。


/

//正确:
if (i > 0)
{
  m = 1;
  n++;
}
//不得写做
if (i > 0) {m = 1;
n++;}
//例外
if (i == 0)
{ ASSERT(FALSE); return; }


  • 在循环、分支之后若只有一行代码,虽然可省略‘{’、‘}’,但不推荐这么做。若省略后可能引起歧义,则必须加上‘{’、‘}’。


与空格有关的各项规定。


  • 在所有两目、三目运算符的两边都必须有空格。在单目运算符两端不必空格。但在‘->’、‘::’、‘.’、‘[’、‘]’等运算符前后,及‘&’(取地址)、‘*’(取值)等运算符之后不得有空格。


//正确:
int n = 0, nTemp;
for (int i = nMinLine; i <= nMaxLine; i++)
//不得写做
int n=0, nTemp;
for ( int i=nMinLine; i<=nMaxLine; i++ )


  • for、while、if 等关键词之后应有1个空格,再接‘(’,之后无空格;在结尾的‘)’前不得有空格。


/

//正确
if (-2 == n)
//不得写做:
if(-2 == n)
//或
if ( -2 == n )


  • 调用函数、宏时,‘(’、‘)’前后不得有空格。


//正确:
printf("%d\n", nIndex);
//不得写做:
printf ("%d\n", nIndex);
printf( "%d\n", nIndex );


  • 类型强制转换时,‘(’‘)’前后不得有空格


//可写做:
(KSFile*)pFile;
//也可写做:
(KSFile *)pFile
//不得写做:
( KSFile* )pFile
( KSFile * ) pFile


  • 与缩进有关的各项规定


缩进以 Tab 为单位。1 个 Tab 为 4 个空格

下列情况,代码缩进一个 Tab:


  1. 函数体相对函数名及‘{’、‘}’。


int Power(int x)
{
  return (x * x);
}


  1. if、else、for、while、do 等之后的代码。


  1. 一行之内写不下,折行之后的代码,应在合理的位置进行折行。若有 + - * / 等运算符,则运算符应在上一行末尾,而不应在下一行的行首。


  • 下列情况,不必缩进:switch 之后的 case、default。


switch (nID)
{
case ID_PLAY:
  ......
  break;
case ID_STOP:
  ......
  break;
default:
  ......
  break;
}


相关文章
|
5月前
|
存储 编译器 C语言
【C++】C++中规范[ 类型转换标准 ] 的四种形式
【C++】C++中规范[ 类型转换标准 ] 的四种形式
|
5月前
|
安全 编译器 C语言
MISRA C++ 、Google C++ 、AUTOSAR Adaptive Platform编码 C++ 规范总结
MISRA C++ 、Google C++ 、AUTOSAR Adaptive Platform编码 C++ 规范总结
178 1
|
5月前
|
设计模式 存储 算法
C++从入门到精通:3.7阅读和理解开源项目——在实际项目中应用C++编程技巧和规范
C++从入门到精通:3.7阅读和理解开源项目——在实际项目中应用C++编程技巧和规范
115 0
|
5月前
|
算法 Unix 程序员
【C/C++ 基本知识 注释规范】C/C++中注释方式以及规范
【C/C++ 基本知识 注释规范】C/C++中注释方式以及规范
63 0
谷歌风格C++命名规则
谷歌风格C++命名规则
296 0
|
Oracle 安全 关系型数据库
Oracle中国C/C++软件工程师代码编写规范2017公开版
Oracle中国C/C++软件工程师代码编写规范2017公开版
|
C++
C++规范文档
本篇内容记录了C++的命名规范、注释规范。
670 0
C++规范文档
|
C++
牛客网输入规范总结(c++部分)
注意:输入的多组输入,不是一组,已经猜了很多次坑了哦!   输入 预先不输入数据的组数 while(cin>>a>>b){ cout>b; coutb; cout>b; cout>b; ...
5400 0
|
20天前
|
编译器 C++
C++ 类构造函数初始化列表
构造函数初始化列表以一个冒号开始,接着是以逗号分隔的数据成员列表,每个数据成员后面跟一个放在括号中的初始化式。
60 30