C++编程命名规范

必须遵循几种简单的C++命名规则:

1.在名称中只能使用字母字符、数字和下划线(_)
2.名称的第一个字符不能是数字
3.区分大写字符与小写字符
4.不能将C++关键字用作名称
5.以两个下划线或下划线和大写字母打头的名称被保留给实现(编译器及其使用的资源)使用。以一个下划线开头的名称被保留给实现,用作全局标识符。
6.C++对于名称的长度没有限制,名称中所有的字符都有意义,但有些平台有长度限制。

除了要遵循C++中的命名规则外,如果想要有效的管理一个稍微复杂一点的体系,针对其中事物的一套统一、带层次结构、清晰明了的命名准则就是必不可少而且非常好用的工具。

命名法则

目前,业界共有四种命名法则:驼峰命名法、匈牙利命名法、帕斯卡命名法和下划线命名法,其中前三种是较为流行的命名法。

  1. 驼峰命令法,正如它的名称所表示的那样,是指混合使用大小写字母来构成变量和函数的名字。
    示例:printEmployeePaychecks()
  2. 匈牙利命名法,通过在变量名前面加上相应的小写字母的符号标识作为前缀,标识出变量的作用域、类型等。这些符号可以多个同时使用,顺序是先m_(成员变量)、再指针、再简单数据类型、再其它。这样做的好处在于能增加程序的可读性,便于对程序的理解和维护。匈牙利命名法关键是:标识符的名字以一个或者多个小写字母开头作为前缀;前缀之后的是首字母大写的一个单词或多个单词组合,该单词要指明变量的用途。
    示例:m_lpszStr,表示指向一个以0字符结尾的字符串的长指针成员变量。
  3. 帕斯卡命名法(也叫大驼峰命名),与驼峰命名法类似,二者的区别在于:驼峰命名法是首字母小写,而帕斯卡命名法是首字母大写,
    示例:DisplayInfo(); string UserName
  4. 下划线命名法,常用于python的编程命名中,示例:print_employee_paychecks()

命名的基本原则

规则说明
同一性在编写一个子模块或派生类的时候,要遵循其基类或整体模块的命名风格。
望文知意标识符采用英文单词或其组合,应当直观且可以拼读,可望文知意,用词应当准确。在变量名中加入其他的信息,即描述变量类型或内容的前缀。例如,将整型变量myWeight命名为nMyWeight,其中前缀n用来表示整数值str或sz表示以空字符结束的字符串b表示布尔值p表示指针c表示单个字符
最小化长度 && 最大化信息量原则在保持一个标识符意思明确的同时,应当尽量缩短其长度。
避免过于相似不要出现仅靠大小写区分的相似的标识符,例如i与I,function与Function等等。
避免在不同级别的作用域中重名程序中不要出现名字完全相同的局部变量和全局变量,尽管两者的作用域不同而不会发生语法错误,但容易使人误解。
正确命名具有互斥意义的标识符用正确的反义词组命名具有互斥意义的标识符,如:nMinValue和nMaxValue,GetName() 和 SetName() 等。
避免名字中出现数字编号尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为用数字编号最省事)

综上所述,我们宜采用匈牙利命名法。

类/接口

​ 除了异常类等个别情况(不希望用户把该类看作一个普通的、正常的类之情况)外,C++类/接口的命名应该遵循以下准则:

C++类/接口的命名
类的名称都要以大写字母C开头,后跟一个或多个单词。接口以大写I开头,代表Interface。为便于界定,每个单词的首字母要大写。
推荐的组成形式
类的命名推荐用 “名词” 或“形容词+名词”的形式,例如:CAnalyzer,CFastVector,IFactory 等。

函数的名称由一个或多个单词组成。为便于界定,每个单词的首字母要大写。最长不得超过20个字符。

组成形式:
全局函数应当使用“动词”或者“动词+名词”(动宾词组)的形式。例如:gGetName(), gDrawBox()。定义了命名空间的全局函数则可以无需前缀。
类成员函数应当只使用”动词“,被省略掉的名词就是对象本身。例如: box->Draw();。

变量

​变量应该是程序中使用最多的标识符了,变量的命名规范可能是一套C++命名准则中最重要的部分。

​变量名由 作用域前缀+类型前缀+一个或多个单词+数据结构标识 组成,为便于界定,每个单词的首字母要大写。其中对于“数据结构标识”可以作为类型前缀使用,也可以作为后缀使用。对于某些用途简单明了的局部变量,也可以使用简化的方式,如:i, j, k 。

作用域前缀
作用域前缀标明一个变量的可见范围。作用域可以有如下几种:

前缀**说明 **
局部变量
m_类的成员变量(member)
sm_类的静态成员变量(static member)
s_静态变量(static)
g_外部全局变量(global)
sg_静态全局变量(static global)
gg_进程间共享的共享数据段全局变量(global global)
类型前缀
类型前缀标明一个变量的类型,可以有如下几种:
**前缀 **说明
n整型和位域变量(number)
l长整型(long)
u无符号型(unsigned)
ch字符型变量(char)
str字符串型变量(char[],string)
b布尔型变量(bool)
f浮点型变量(float)
d,lf双精度浮点型变量(double)
p指针型变量和迭代子(pointer)
lp远指针
pfn特别针对指向函数的指针变量和函数对象指针(pointer of function)
c常量(constant)
lpszLPSTR、LPCSTR、LPCTSTR
byBYTE
wWORD
dwDWORD
hhandle,Window句柄对象
it迭代器(iterator)

可添加数字说明变量位数,例如:m_u16Number,n32Temp 等。

数据结构标识

类型前缀后缀说明
arrayArray数组
mapMap映射
setSet集合
listList列表
queQueue, Que队列
vecVector, Vec向量

推荐的组成形式
变量的名字应当使用“名词”或者“形容词+名词”。例如:nCode,m_fPostionX,mapTemp,m_nResultList ,g_strFileNameArray等。

常量

​ 常量名由类型前缀+全大写字母组成,单词间通过下划线来界定,类型前缀的定义与变量命名规则中的相同。

例如:cDELIMITER,nMAX_BUFFER。

结构体、宏、枚举、联合

​ 结构体、宏、枚举、联合命名全部由 前缀+大写 字母组成,单词间使用下划线界定。

结构体
加小写前缀"tag",之后以大写字母开头。

typedef struct tagPOINT
{
    int x;
    int y;
} POINT;

#define MAXNUMBER 100

枚举变量

typedef enum _FILE_OPEN_MODE
{
    OPEN_READONLY,
    OPEN_READWRITE
} FILE_OPEN_MODE;

联合体

typedef union _VARIANT
{
    char unichVal;
    int uninVal;
    float uniftVal;
} VARIANT;

构建自己的命名规范

结合以上命名规则和自己的习惯构建一套适合自己的命名规范。

类型命名规则示例
普通函数大驼峰法GetName()
成员函数小驼峰法getName()
变量匈牙利命名法m_lpszStr,m_nResultList
类/结构体大驼峰法class MyClass
接口I+大驼峰法class IMyInterface
常量前缀+大写nMaxValue
宏/枚举大写+下划线法DEBUG_PRO

注:以上为主要遵循的命名规则,必要情况下可以适当联合下划线法进行命名。

参考文献
https://blog.csdn.net/qq_40935205/article/details/127929000

  • 1
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
C编程规范PDF是一种编程规范的文档形式,用于指导和规范C语言编程的风格和标准。通过遵循C编程规范,可以提高代码的可读性、可维护性和可移植性,从而减少错误和提高开发效率。 C编程规范PDF通常包含以下内容: 1. 命名约定:指定变量、函数、宏等的命名规则,例如使用有意义的名称,避免使用缩写或数字开头等。 2. 缩进和格式化:定义缩进和代码格式化的规则,例如使用空格或制表符进行缩进,并规定代码块的大括号的位置等。 3. 注释规范:规定注释的格式和位置,描述代码的功能、作者、日期等信息,并提供必要的注释以增加代码的可读性。 4. 函数和变量声明:规定函数和变量的声明方式,例如声明的位置、类型的命名规则、参数的顺序和命名等。 5. 错误处理:规定如何处理错误和异常情况,例如使用错误码、异常处理、日志记录等方式。 6. 编程技巧和最佳实践:提供一些编程技巧和最佳实践,帮助开发人员避免常见错误和提高代码的质量。 7. 编程风格:规定编码风格的一致性,例如使用驼峰命名法、每行最大字符数、运算符的位置等。 通过使用C编程规范PDF,开发人员可以遵循一致的编码规则,减少代码错误和风格上的不一致,提高代码的可读性和可维护性。这对于团队开发尤其重要,因为不同开发人员的风格和习惯可能有所不同。同时,C编程规范PDF还可以作为培训和文档的参考,帮助新的开发人员快速适应团队的编码规范。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值