代码规范:命名规则

简介: 【规则 3-2-6】类的数据成员加前缀 m_(表示 member),这样可以避免数据成员与成员函数的参数同名
  1. 如果是函数名称,使用首字母大写其余小写的方式
  2. 如果是变量名,采用匈牙利法
int iNum;
float fNum;
double doNum;
char chBuf;
string strName;
char *pName;
int *pNum;


3.1 共性规则

【规则 3-1-1】标识符应当直观且可以拼读,可望文知意,不必进行“解码”。

标识符最好采用英文单词或其组合,便于记忆和阅读。切忌使用汉语拼音来命名。

程序中的英文单词一般不会太复杂,用词应当准确。例如不要把 CurrentValue 写成

NowValue。


【规则 3-1-2】标识符的长度应当符合“min-length && max-information”原则。

几十年前老 ANSI C 规定名字不准超过 6 个字符,现今的 C++/C 不再有此限制。一

般来说,长名字能更好地表达含义,所以函数名、变量名、类名长达十几个字符不足为

怪。那么名字是否越长约好?不见得! 例如变量名 maxval 就比 maxValueUntilOverflow

好用。单字符的名字也是有用的,常见的如 i,j,k,m,n,x,y,z 等,它们通常可用作函数

内的局部变量。


【规则 3-1-3】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。

例如 Windows 应用程序的标识符通常采用“大小写”混排的方式,如 AddChild。 而 Unix 应用程序的标识符通常采用“小写加下划线”的方式,如 add_child。别把这两类风格混在一起用。


【规则 3-1-4】程序中不要出现仅靠大小写区分的相似的标识符慎重使用O0这种易混淆的内容


【规则 3-1-5】程序中不要出现标识符完全相同的局部变量和全局变量,尽管两者的

作用域不同而不会发生语法错误,但会使人误解


【规则 3-1-6】变量的名字应当使用“名词”或者“形容词+名词”。


【规则 3-1-7】全局函数的名字应当使用“动词”或者“动词+名词”(动宾词组)。

类的成员函数应当只使用“动词”,被省略掉的名词就是对象本身。但是当类对象使用时,应当保证成员对象名称通俗易懂


【规则 3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。Get对Set min对max send对recv


简单的命名规则

【规则 3-2-1】类名和函数名用大写字母开头的单词组合而成。


【规则 3-2-2】变量和参数用小写字母开头的单词组合而成。

【规则 3-2-3】常量全用大写的字母,用下划线分割单词。

【规则 3-2-4】静态变量加前缀 s_(表示 static)

【规则 3-2-5】如果不得已需要全局变量,则使全局变量加前缀 g_(表示 global)。


【规则 3-2-6】类的数据成员加前缀 m_(表示 member),这样可以避免数据成员与成员函数的参数同名

【规则 3-2-7】为了防止某一软件库中的一些标识符和其它软件库中的冲突,可以为各种标识符加上能反映软件性质的前缀。例如三维图形标准 OpenGL 的所有库函数均以 gl 开头,所有常量(或宏定义)均以 GL 开头。如象元的代码可以使用XY开头


服务器高级架构体系:https://xxetb.xet.tech/s/4DEnTI

目录
相关文章
|
JavaScript 前端开发 搜索推荐
|
XML 算法 安全
C#编码规范
本篇内容记录了 命名惯例和规范、 ** 良好的编程习惯、** 注释 、 ** 异常处理
578 0
C#编码规范
|
1月前
|
Java 开发者
在Java编程中,正确的命名规范不仅能提升代码的可读性和可维护性,还能有效避免命名冲突。
【10月更文挑战第13天】在Java编程中,正确的命名规范不仅能提升代码的可读性和可维护性,还能有效避免命名冲突。本文将带你深入了解Java命名规则,包括标识符的基本规则、变量和方法的命名方式、常量的命名习惯以及如何避免关键字冲突,通过实例解析,助你写出更规范、优雅的代码。
54 3
|
4月前
|
JavaScript 前端开发 Java
驼峰命名规范及其在代码可读性中的重要性
驼峰命名规范及其在代码可读性中的重要性
|
5月前
|
Web App开发 前端开发 定位技术
前端命名规范以及常用命名整理
这是一份关于HTML和CSS编码规范的摘要: - 文件编码统一使用UTF-8。 - 命名遵循语义化,CSS属性书写规范,推荐使用中线命名法(如`hello-world`),避免下划线和驼峰命名。 - 样式应复用,模块化,便于移植。 - 避免使用CSS Hack,优先考虑浏览器兼容性。 - 针对Firefox设计,用IE条件注释做修正。 - 使用英文命名,避免拼音,少用缩写,不以数字开头。 - 常见命名包括页面结构(如`container`、`header`)、导航(`nav`、`subnav`)、功能区域(`logo`、`search`)等,提供了一套常见的ID和Class命名约定。
常见代码命名规范
常见代码命名规范
118 0
|
前端开发 JavaScript
|
OLAP
代码命名规范
代码命名规范
131 0
|
程序员 C++
编程命名规则
编程命名规则
112 0
|
JSON 前端开发 JavaScript
规范(一):代码规范
规范(一):代码规范
规范(一):代码规范