驼峰式与下划线命名规则

2023-05-16

在实际代码开发过程中,代码编写格式清晰与否不仅决定了自己的代码编写与维护成本,也直接影响到项目的开发进度。编码中常用的有驼峰法和下划线两种编码格式,其中驼峰法常用在面向对象的高层语言中,下划线方法常用在偏向底层的语言中。

1. 驼峰命名规则(Camel case With hungarian notation)

驼峰式命名法(camel-case)一次来自于Perl语言中普遍使用的大小写混合格式,而Larry wall等人所著的畅销书《program Perl》(o'Relly出版)的封面图片正是一匹骆驼,故而得名。驼峰法在C++等高级语言中被广泛使用,下划线方法占据现有的C语言体系。匈牙利方法在win的老用户中广泛被使用,但是匈牙利方法在当下命名体系当中使用越来越少。或者,准确的讲是随着技术进步,这种命名逐渐与驼峰法结合再了一起形成了一种适合于现在C++等高级语言的项目命名规范。  

驼峰式命名法分为大驼峰(big camel-case)和小驼峰(little camel-case)两种。其中,大驼峰特点是首字母与后边字母都是大写,常用于类名、函数名、属性和命名空间。相比较,小驼峰特点是首单词开头字母小写后边字母都是大写,常用于局部变量。

## 概要 General  

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

活跃在生物学、化学、军队、监狱、黑社会、恐怖组织等各个领域内的大量有识先辈都曾经无数次的以实际行动证明了以上公理的正确性。除了上帝(设他可以改变世间万物的秩序)以外,象形没有人有实力对它不屑一顾。在软件开发这一高度抽象而且高度复杂的活动中,命名规则的重要性更显得尤为突出。一套定义良好并且完整的、再整个项目中统一使用的命名规范将大大提升源代码的可读性和软件的可维护性。在引入细节之前,先说明一下命名规范的整体原则:  

标准      说明                                                      
统一性在编写一个子模块活派生类的时候,要遵循其基类或整体模块的命名规范风格,保持命名规范风格再整个模块中的统一性
标识组成标识符采用英文单词或其组合,应当只管且可以平度,有望文知意,用词适当准确
最小化长度与最大化信息量原则再保持一个标识符意思明确的同时,尽量缩短其长度。方法是准确使用英语,同时使用单词缩写
避免过于相似不要出现仅靠大小写区分的相似标识符,例如“i”与“I”,“function” 与“Function”等等。
避免在不同级别的作用域中重名程序不要出现名字完全相同的局部变量和全局变量,尽管两者作用于不同而不会发生语法错误,但容易使人误解
正确命名具有互斥意义的标识符用正确的反义词命名具有互斥意义的标识符,如:“nMinValue”和“nMaxValue”,“GetName()”和“SetName()”
避免名字中出现数字编号尽量名字中出现数字编号,如value1,value2等,除非逻辑上的确需要编号。这是为了放置程序员偷懒,不肯为命名董道静而导致产生无意义的名字(因为数字编号最省事)。

## 类/结构class  

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

类型命名方法
C++类/结构的命名类的名称都是以大写字母“C"开头,后跟一个活多个单词。为便于界定,每个单词的首字母要大写
推荐的组成形式类的命名推荐用名词或形容词+名词的形式,例如:“CAnalyzer”,“CFastVector”等等
传统C结构体命名传统C结构体的名称全部有大写字母组成,单词间使用下划线界定,例如:SERVICE_STATUS

不同于C++类的概念,传统的C结构体只是一种将一组数据捆绑在一起的方式。传统C结构体的命名规则:

## 函数 Function  

类型说明
函数命名函数的名称由一个或多个单词组成,为便于界定,每个单词的首字母要大写
推荐的组成形式函数名应当使用动词或者动词+名词(动宾词组)的形式。例如:“GetName()", "SetValue()","Reserve()"
保护成员函数保护成员函数的开头应该加上一个下划线“-”以示区别,例如:“————SetState()”
私有成员函数类似地,私有成员函数的开头应当加上两个下划线“__”,例如:“__DestoryImp()”
虚函数虚函数习惯使用Do开头,例如:“DoRefresh()","_DoEncryption()”
回调和事件处理函数回调和时间处理函数习惯以单词“On”开头,例如:“_OnTimer()"

## 变量  

变量应该是程序中使用最多的标识符,变量的命名规范可能是一套C++标准规范中最重要的部分,具体命名规范如下:

变量的命名  变量有作用域前缀+类型前缀+一个或多个单词组成。为了便于界定,每个单词的首字母要大写。对于某些用途简单的明了的局部变量,也可以使用简化的方式,例如:i,j,k....

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

前缀                说明

无                  局部变量

m_                  类的成员变量(member)

sm_                 类的静态成员变量(static member)

s_                  静态变量(static)

g_                  外部全局变量(global)

sg_                 静态全局变量(static glboal)

gg_                 进程共享的共享数据段全局变量(global global)

除非不得已,否则应该竟可能少的使用全局变量  

类型前缀            类型前缀标明一个变量的类型

前缀                说明

n                   整形和位域变量(number)

e                   枚举型变量(enumeration)

c                   字符型变量(char)

b                   布尔型变量(bool)

f                   浮点型变量(float)

p                   指针型变量和迭代子(pointer)

pfn                 特别针对直线函数的指针变量和函数对象指针(pointer of function)

g                   数组(grid)

i                   类的实例(instance)

                    对于经常使用到的类也可以定义一些专门的前缀,比方说std::vector这种容器类型的固有约束型变量,可以使用v等

                    类型前缀可以组合使用,例如“gc”表示字符数组,“ppn”表示只想整形的指针的指针等

char*/wchar_t* -> psz

char[]/wchar_t[] ->sz

sz 表示string end of zero

S                   结构体 SAddress

前缀

类型

描述

实例

c

char

8位字符

cGrade

str string  字符型 strName

ch

TCHAR

如果_UNICODE定义,则为16位字符

chName

b

BOOL

布尔值

bEnable

n ,i

int

整型(其大小依赖于操作系统)

nLength

si

short int   短整型 siSequ

n

UINT

无符号值(其大小依赖于操作系统)

nHeight

w

WORD

16位无符号值

wPos

f

float   浮点型 fRadius

d

double  双精度型    dArea

l

LONG

长整型

lOffset

ld

long double 长双精度型   ldRate

dw

DWORD

32位无符号整型

dwRange

p

*

指针

pDoc

lp

FAR*

远指针

lpszName

lpsz

LPSTR

32位字符串指针

lpszName

lpsz

LPCSTR

32位常量字符串指针

lpszName

lpsz

LPCTSTR

如果_UNICODE定义,则为32位常量字符串指针

lpszName

h

handle

Windows对象句柄

hWnd

lpfn

callback

指向CALLBACK函数的远指针

?

if

输入文件流   ifDataFile

of

输出文件流   ofStuFile

sz

以"\0"结束的字符串 szAppName


 

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

## 常量

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

## 枚举、联合、typedef

枚举、联合以及typedef语句生成的累死你个名有全大写字母组成,单词间通过下划线来界定,如:FAR_PROC

## 宏、枚举值  

宏和枚举值由全大写字母组成,单词通过下划线来界定,如:ERROR_UNKNOWN,OP_STOP...

## Property  

g_                  Global variable/function  

c_                  Const variable

C                   class  

m_                  Member of struct/class  

s_                  Static variable  

S                   Struct  

## Componnet

Button              btn

Label               lbl

TextBox             txt

## varibal  

pointer             p  

char*

2. 下划线命名规则

在Linux操作系统这种用C语言写的代码中,根据之前的编码风格延续使用下划线编码规范。这种编码规范相比于驼峰法差别在于文字之间组成意义单词语义分割方式,下划线使用“_”进行区分。在其他变量方便的定义和区分规则,两者之间是没有差别的。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

驼峰式与下划线命名规则 的相关文章

  • Java--a++与 ++a 与 a=a+1 与a+=1

    a 43 43 等效 a 61 a 43 1 43 43 a 等效 a 43 61 1 计算顺序的区别 xff1a a 43 43 是先参加程序的运行再 43 1 xff0c 而 43 43 a则是先 43 1再参加程序的运行 举例 xff
  • 数据仓库系列文章二:浅谈企业数据仓库总线矩阵

    Kinball在 数据仓库工具箱 一书中 xff0c 详细阐述维度建模思想 xff0c 并给出维度建模的众多实践 维度建模的核心内容和建设过程在实践中已经被大家所熟知 xff0c 网上教程也很多 xff0c 本文不做赘述 本文重点谈一谈企业
  • Java中 List、Set、Map 之间的区别

    小博此篇记录了开发过程中常用的几种集合详解 xff0c 三者的区别对比均从IDEA相关层次图里面所得知 xff0c 基于JDK8 xff0c 如有错误欢迎批评指正 List 列表 List的元素以线性方式存储 xff0c 可以存放重复对象
  • DuiLib介绍及其消息处理剖析

    DirectUI技术 DirectUI意为直接在父窗口上绘图 Paint on parent dc directly 即子窗口不以窗口句柄的形式创建 windowless xff0c 只是逻辑上的窗口 xff0c 绘制在父窗口之上 微软的
  • xargs命令

    原作者地址 xff1a https www cnblogs com chyingp p linux command xargs html 感谢原作者 Linux基础 xff1a xargs命令 简介 xargs可以将输入内容 xff08 通
  • 为何HBase速度很快?

    为何HBase速度很快 xff1f HBase能提供实时计算服务主要原因是由其架构和底层的数据结构决定的 xff0c 即由LSM Tree Log Structured Merge Tree 43 HTable region分区 43 Ca
  • VirtualBox虚拟机不能ping通宿主机的解决方法

    解决VirtualBox虚拟机不能ping通宿主机的问题 问题描述 在VirtualBox虚拟中 xff0c 无法ping通宿主机 xff0c 宿主机可以ping通虚拟机 虚拟机的网络已经设置为 桥接网卡 xff0c 也可以正常上网 问题原
  • CMake 使用方法 & CMakeList.txt

    cmake 简介 CMake是一个跨平台的安装 编译 工具 可以用简单的语句来描述所有平台的安装 编译过程 他能够输出各种各样的makefile或者project文件 能测试编译器所支持的C 43 43 特性 类似UNIX下的automak
  • Hadoop安装目录

    root software hadoop 2 6 0 cdh5 15 1 etc hadoop 第一步骤 vi core site xml lt configuration gt lt property gt lt name gt fs d
  • 前端之浏览器

    你会不会和我一样 xff0c 开发了N年 xff0c 真要讲起浏览器 xff0c 发现自己一无所知 常用那几种浏览器测试 xff1f IE Safari Chrome Mozilla Firefox Opera 主流浏览器的内核有哪些 xf
  • Navicat远程连接Linux环境下MySQL(错误error:1045/1251/2003(10038)/2059)解决方案

    Navicat远程连接Linux环境下MySQL 错误error 1045 1251 2003 10038 2059 解决方案 心路历程 因为之后要学习有关数据库开发的课程 xff0c 我们需要部署云服务器并添加mysql功能 xff0c
  • MAX30102 血氧调试笔记

    一 血氧测量原理 1 1 PPG波形介绍 血氧饱和度 xff08 英语 xff1a Oxygen saturation xff09 xff0c 或称血氧浓度 xff0c 是指血中氧饱和血红蛋白相对于总血红蛋白 xff08 不饱和 43 饱和
  • HBase - Filter - 过滤器的介绍以及使用 | 那伊抹微笑

    博文作者 xff1a 那伊抹微笑 csdn 博客地址 xff1a http blog csdn net u012185296 itdog8 地址链接 http www itdog8 com thread 214 1 1 html 博文标题
  • sphereface:deep hypersphere embedding for face recognition

    SphereFace算法详解 AI之路 CSDN博客 sphereface 论文 xff1a SphereFace Deep Hypersphere Embedding for Face Recognition 论文链接 xff1a htt
  • python中的isdigit( )的使用

    python中的isdigit 函数是检测输入字符串是否只由数字组成 第三个例子既包含数字 xff0c 也包含字符串的话 xff0c 返回的也是一个False的布尔值 举例 xff1a
  • Debian没有sudo怎么办

    和Ubuntu不同 xff0c sudo命令在原始的Debian系统中时没有的 xff0c 需要额外安装 sudo apt get install sudo 编辑配置文件 xff0c 增加一个可以使用sudo命令的用户名 UserName
  • ES6——给对象部署Iterator接口

    Iterator接口的目的就是为所有数据结构提供一种统一访问的机制 xff0c 用for of 实现 一个数据结构只要有Symbol iterator属性 xff0c 就可以认为是 可遍历的 原型部署了Iterator接口的数据结构有三种
  • 我还在坚持的道路上

    高考 xff0c 一个似乎已经久远的经历但却又有一种恍如昨日的感觉 记得那年 2012年 xff0c 考完最后一场 xff0c 下着大暴雨 xff0c 那一刻有一种终于解放的窃喜但内心又憋着无形的鸭梨 xff0c 不知道最后结果会怎样 不过
  • CodeBlocks的下载安装、配置、简单编程

    IDE简介 http www baidu com s wd 61 codeblocks xff0c 这里只是介绍Windows平台下的 IDE 环境配置 CodeBlocks的下载 安装 配置 xff1a 下载 xff1a http www

随机推荐

  • 四、安装cuDNN,caffe和openCV

    一 安装cuDNN 1 下载cudnn 可以注册再下载 不过有点麻烦 官网https developer nvidia com cudnn 或者百度云下载http pan baidu com s 1hrAMHko 2 安装 tar span
  • 网络爬虫(三)------宽度优先爬虫(一个的基础,简单但是很重要哦)

    在实际项目中 xff0c 我们使用爬虫遍历互联网 xff0c 把网络中相关的网页全部抓取过来 xff0c 这也体现了爬虫的特点 爬虫爬行的过程是这样子的 xff1a 互联网中每一个页面看作是一个节点 xff0c 页面中的链接可以看成图的有向
  • Win10+Ubuntu双系统修复Ubuntu系统引导

    这两天笔者安装win10 43 ubuntu16 04双系统 xff0c 因为网络上能找到大量的资料 xff0c 安装过程此处就不多讲 因为笔者电脑是华硕主板 xff0c bios默认设置为安全启动 xff0c 笔者猜测会阻止加载ubunt
  • 全面分析 Spring 的编程式事务管理及声明式事务管理

    关于本教程 本教程将深入讲解 Spring 简单而强大的事务管理功能 xff0c 包括编程式事务和声明式事务 通过对本教程的学习 xff0c 您将能够理解 Spring 事务管理的本质 xff0c 并灵活运用之 先决条件 本教程假定您已经掌
  • classpath*作用

    classpath It refers to a list of resources and loads all such files present in the classpath and list can be empty and i
  • java 8 根据map 字段值 去重

    java 8 根据map 字段值 去重 span class token class name List span span class token generics span class token punctuation lt span
  • java 8 去重

    span class token comment 取差集 span span class token class name List span span class token generics span class token punct
  • 解读程序员的武侠世界,顶级程序员是内外兼修的大侠,那么你呢?

    在漫天的星河中 xff0c 有这样一颗星 xff0c 他朴实无华 xff0c 却又熠熠生辉 xff0c 照亮了无数人的人生 他就是金庸先生 随着一代大侠的驾鹤西去 xff0c 飞雪连天射白鹿 xff0c 笑书神侠倚碧鸳 xff0c 成为绝响
  • Eclipse使用入门教程

    Eclipse使用入门教程 说起java的IDE xff0c 朗朗上口的无非是Eclipse了 xff0c 假若能熟练Eclipse xff0c 对于我们编写java程序会起到事半功倍的效果 xff0c 大大提高我们工作效率 因此本篇博文
  • Win7 + Ubuntu16.04 双系统安装

    之前安装win7 43 Ubuntu14 04双系统 xff0c 后来换成win10用了一段时间后觉得有些卡 xff0c 而且装双系统装了几次都成功 xff0c 所以又换回了win7系统 xff0c 并重新安装了win7 43 Ubuntu
  • 双系统Ubuntu 引导修复(Boot Repair)

    安装完双系统 xff0c 如果在使用过程中不小心删除了Ubuntu引导向 xff0c 则会导致开机后无法选择进入Ubuntu系统 或者当我们重装了windows系统后 xff0c 也会发现原来的Ubuntu引导不见了 xff0c 当出现这两
  • 数据库为何要有复合主键(多主键)

    最近学习一点数据库的基本知识 xff0c 被一个问题困惑了许久 xff1a 主键是唯一的索引 xff0c 那么为何一个表可以创建多个主键呢 xff1f 其实 主键是唯一的索引 这话有点歧义的 举个例子 xff0c 我们在表中创建了一个ID字
  • @JSONField 注解详解和应用

    讲到 64 JSONField 注解 xff0c 就不得不提到Alibaba 开源的fasejson fastjson是目前java语言中最快的json库 xff0c 比自称最快的jackson速度要快 xff0c 第三方独立测试结果看这里
  • 外部访问docker容器(docker run -p/-P 指令)

    容器中可以运行一些网络应用 xff0c 要让外部也可以访问这些应用 xff0c 可以通过 P xff08 大写 xff09 或 p xff08 小写 xff09 参数来指定端口映射 xff08 1 xff09 当使用 P 标记时 xff0c
  • 解决Spring Boot和Feign中使用Java 8时间日期API(LocalDate等)的序列化问题

    LocalDate LocalTime LocalDateTime 是Java 8开始提供的时间日期API xff0c 主要用来优化Java 8以前对于时间日期的处理操作 然而 xff0c 我们在使用Spring Boot或使用Spring
  • gcc 编译选项

    原来 Os相当于 O2 5 是使用了所有 O2的优化选项 xff0c 但又不缩减代码尺寸的方法 ffunction sections fdata sections Place each function or data item into
  • RYU功能开发(一)从simple switch开始

    对于任意一款控制器 xff0c 想要快速了解其开发机制 xff0c 从转发模块入手无疑是最佳的学习方式 RYU通过App的形式提供了一系列功能模块 xff0c 其中包括使用了OpenFlow作为控制协议的二层交换机控制模块simple sw
  • arm-linux-gcc交叉工具链

    Linux ARM交叉编译工具链制作过程 一 下载源文件 源代码文件及其版本与下载地址 xff1a Binutils 2 19 tar bz2 Index of gnu binutils gcc 4 4 4 tar bz2 Index of
  • 我使用过的Linux命令之cal - 显示日历

    我使用过的Linux命令之cal 显示日历 本文链接 xff1a http codingstandards iteye com blog 807962 xff08 转载请注明出处 xff09 用途说明 cal命令可以用来显示公历 xff08
  • 驼峰式与下划线命名规则

    在实际代码开发过程中 xff0c 代码编写格式清晰与否不仅决定了自己的代码编写与维护成本 xff0c 也直接影响到项目的开发进度 编码中常用的有驼峰法和下划线两种编码格式 xff0c 其中驼峰法常用在面向对象的高层语言中 xff0c 下划线