首页 > 其他分享 >C语言常见命名规范

C语言常见命名规范

时间:2023-09-05 16:35:16浏览次数:38  
标签:下划线 规范 C语言 单词 首字母 帕斯卡 命名 函数

C语言常见命名规范

 

1 常见命名规则

比较著名的命名规则首推匈牙利命名法,
这种命名方法是由Microsoft程序员查尔斯·西蒙尼(Charles Simonyi) 提出的。
其主要思想是“在变量和函数名中加入前缀以增进人们对程序的理解”。
匈牙利命名法关键是:标识符的名字以一个或者多个小写字母开头作为前缀;
前缀之后的是首字母大写的一个单词或多个单词组合,该单词要指明变量的用途。
例如:lpszStr, 表示指向一个以'\0'结尾的字符串(sz)的长指针(lp)变量。

骆驼(Camel)命名法近年来越来越流行,
在许多新的函数库和Java这样的平台下使用得当相多。
骆驼命名法,正如它的名称所表示的那样,指的是混合使用大小写字母来构成标识符的名字。
其中第一个单词首字母小写,余下的单词首字母大写。
例如:printEmployeePaychecks(),函数名中每一个逻辑断点都有一个大写字母来标记。

帕斯卡(Pascal)命名法与骆驼命名法类似。
只不过骆驼命名法是第一个单词首字母小写,而帕斯卡命名法则是第一个单词首字母大写。
例如:DisplayInfo()和UserName都是采用了帕斯卡命名法。

在C#中,以帕斯卡命名法和骆驼命名法居多。
事实上,很多程序设计者在实际命名时会将骆驼命名法和帕斯卡结合使用,
例如变量名采用骆驼命名法,而函数采用帕斯卡命名法。

另一种流行的命名规则称为下划线命名法。
下划线法是随着C语言的出现流行起来的,在UNIX/LIUNX这样的环境,以及GNU代码中使用非常普遍。

本章所述的命名规则主要基于下划线命名法发展而来。


2 函数的命名

函数名使用下划线分割小写字母的方式命名:

设备名_操作名()

操作名一般采用:谓语(此时设备名作为宾语或者标明操作所属的模块)或者
谓语+宾语/表语(此时设备名作为主语或者标明操作所属的模块) 等形式,如:

tic_init()
adc_is_busy()
uart_tx_char()

中断函数的命名直接使用 设备名_isr() 的形式命名,如:
timer2_isr()


3 变量的命名

变量的命名也采用下划线分割小写字母的方式命名。
命名应当准确,不引起歧义,且长度适中。如:
int length;
uint32 test_offset;

单字符的名字也是常用的,如i, j, k等,它们通常可用作函数内的局部变量。

tmp常用做临时变量名。

局部静态变量,应加s_词冠(表示static),如:
static int s_lastw;

全局变量(尤其是供外部访问的全局变量),应加g_词冠(表示global),如:
void (* g_capture_hook)(void);


4 常量及宏的命名

采用下划线分割大写字母的方式命名,一般应以设备名作为前缀,
防止模块间命名的重复。如:

#define TIMER0_MODE_RELOAD 2
#define TIMER2_COUNT_RETRIEVE(val) ((uint16)(65536 - (val)))

当然,看作接口的宏可以按照函数的命名方法命名,例如:

#define timer2_clear() (TF2 = 0)
#define timer0_is_expired() (TF0)


5 常用缩写词

原词 缩写

addition add
answer ans
array arr
average avg
buffer buf或buff
capture cap或capt
check chk
count cnt
column col
control ctrl
decode dec
define def
delete del
destination dst或dest
display disp
division div
encode enc
environment env
error err
float flt
frequency freq
header hdr
index idx
image img
increment inc
initalize init
iteration itr
length len
memory mem
middle mid
make mk
message msg
multiplication mul
number num
operand opnd
optimization opt
operator optr
packet pkt
positon pos
previous pre或prev
payload type pt
pointer ptr
return code rc
record rcd
receive recv
result res
return ret
source src
stack stk
string str
subtraction sub
table tab
temporary tmp或temp
total tot
time stamp ts
value val


6 结语

没有一种命名规则可以让所有的程序员赞同。而这多种命名规则也确实各有利弊。

没有必要花太多的精力试图发明最好的命名规则,
而是应当制定一种令大多数项目成员满意的命名规则并切实执行。
标识符命名的一致性自然会体现出代码的优雅。

当然,如果你的程序使用了第三方的代码,而这些模块经验证确实是正确无误的。
那么也没有必要一味追求命名的一致性,而去修改这些已经定型的模块中的函数和变量名。


标签:下划线,规范,C语言,单词,首字母,帕斯卡,命名,函数
From: https://blog.51cto.com/u_5513510/7373747

相关文章

  • Android平台GB28181历史视音频文件检索规范探讨及技术实现
    技术背景我们在做Android平台GB28181设备接入侧模块的时候,特别是执法记录仪或类似场景,系统除了对常规的录像有要求,还需要能和GB28181平台侧交互,比如实现设备侧视音频文件检索、下载或回放。本文假定记录仪或相关设备已经完成录像,主要来探讨下设备视音频文件检索相关。规范解读先回......
  • twincat3编程规范
    twincat编程遵循IEC61131-3标准1.声明变量及数据类型:变量名不区分大小写;变量名首字符是字母或下划线,由字母、数字、下划线组成;变量名不能包含空格、连续下划线、特殊字符;声明输入输出变量,例如:regwordout AT%Q* :WORD;   regwordin AT%I* :WORD;断电保持变量PE......
  • git-cz 代码提交统一规范配置
    主要插件commitizen:代码提交辅助工具commitlint:代码校验工具husky:githook插件lint-staged:前端文件过滤工具,只检测暂存区代码cz-customizable:自定义提交配置安装步骤1.环境准备git版本,笔者使用gitforwin2.27.0相关钩子无发现问题,也建议>=2.27.0版本,低版......
  • 大厂都在用的Git代码管理规范(转)
    以下文章来源于码农参上 ,作者DrHydra码农参上.专注后端技术分享,有趣、深入、直接,与你聊聊技术。将 脚本之家 设为“星标⭐”第一时间收到文章更新 来源:码农参上(ID:CODER_SANJYOU)作者:DrHydra分支命名master分支master为主分支,也是用于部署生产环境的分支,需要确......
  • Git代码管理规范
    Git代码管理规范分支命名master分支master为主分支,也是用于部署生产环境的分支,需要确保master分支稳定性。master分支一般由release以及hotfix分支合并,任何时间都不能直接修改代码。develop分支develop为开发环境分支,始终保持最新完成以及bug修复后的代码,用于前......
  • C语言模拟实现字符串操作函数
    在c语言中,有许多的库函数strlen就是其中的一个该库函数的功能是求字符串的长度接下来就解释一下strlen的工作流程我先定义一个数组:chararr[]="abcdef";strlen就是在字符串中找到\0就停止intmy_strlen(char*p){ intcount=0; assert(p!=NULL);//assert是断言,函数形参有指......
  • C语言——全局变量和局部变量重名了会怎么样
    前言(1)今天在交流群里面看到这样一个问题:为什么这个程序中下面我定义的void型函数smart在全局变量前声明了,但是在man函数中调用了smart函数,m的值打印出来还是0。#include<stdio.h>intm;voidsmart(void);intmain(void){ printf("m=%d.\n",m); smart(); printf("m=......
  • 材料中的光速+defparam用法+C语言的宏使用
    材料中的光速https://blog.csdn.net/weixin_43229030/article/details/106745060空气中,相对介电常数和相对导磁率都为1,光的速度为12in/ns绝大多数互连线中的光速约为12in/ns/sqrt(4)=6in/ns。当估算电路板上互连线中信号的连度对,就可以假定它约为6in/ns。defparam的用法......
  • 东方博宜OJ1010 数组元素的排序 C语言版
    题目描述对数组的元素按从小到大进行排序。输入第一行有一个整数 n ( 5≤n≤10 );第二行有 n 个整数,每个整数的值在 [0,109]的范围内。输出输出排序后的数组。样例输入812368745输出12345678来源数组问题代码 #incl......
  • Google C++编程规范(Google C++ Style Guide)
    参考链接:Google代码规范C++总结Google开源项目风格指南——中文版GoogleC++StyleGuide是一份不错的C++编码指南,我制作了一张比较全面的说明图,可以在短时间内快速掌握规范的重点内容。不过规范毕竟是人定的,记得活学活用。看图前别忘了阅读下面两条重要建议:保持一致也......