怎么快速进行变量和函数的命名?

时间:2025-09-09  作者:Diven  阅读:0

前段时间共享了常用单词的缩写【了近800个工程师写程序常用的英语单词以及缩写;例如:configuration-》cfg】,但仍有不少分析从后台反应,看了英文缩写仍然写不出看着更专业的软件。下面小编再共享一下常用的软件编码的规范和技巧:编程中其实比较头痛的一件事就是定义变量到词穷,编写出看似很专业的软件其实最重要的是变量命名的方法套路,接下来就教教你怎么快速进行变量和函数的命名。

怎么快速进行变量和函数的命名?

命名原则

首先要保证一个原则,一定要和公司或者项目的代码规范统一,其次要保证编码命名的简洁、望文知义。这样做的目的就是为了协作开发和后期还能够快速而准确地理解自己的程序。

1、使用合适的匈牙利命名规则开头加上某种前缀来标识这个变量的类型,或者方法的功能,基本原则就是:变量名=属性+类型+对象描述。例如:

uint8_t ucLen;

uint8_t *pucBuf;

2、变量的命名

变量可以使用缩写,但需要加注释。尽量不要用缩写,如果一定要缩写,一定要坚持统一的缩写原则,下面提供一些方法变量命名的常用方法和注意事项:

(1)有意义的名称: 变量名称应该反映出变量的含义,使人们能够迅速理解变量的作用。

(2)驼峰命名法(CamelCase): 首字母小写,后续单词首字母大写,如 myVariableName。

(3)下划线命名法(Snake Case): 所有字母小写,用下划线分隔单词,如 my_variable_name。

(4)避免使用单个字符: 除非是计数器或迭代变量,尽量避免使用单个字符的变量名,如 i 或 x,因为这可能会降低代码的可读性。

(5)避免使用数字开头: 变量名不应以数字开头,因为以数字开头的变量名在C语言中是无效的。

(6)使用有意义的单词: 选择能够准确描述变量用途的单词,避免使用模糊或难以理解的缩写。

(7)遵循项目的命名约定: 如果项目中已经有一套命名规范,要遵循该规范以保持一致性。

(8)避免使用保留字: 不要使用C语言的保留字作为变量名,以免引发编译错误。

(9)注意命名长度: 变量名不应过长,也不应过短。长度适中,能够准确表达变量的含义即可。

(10)使用名词和动词: 变量名可以使用名词表示对象,也可以使用动词表示操作,以更好地反映变量的用途。

(11)避免过度缩写: 尽量避免过度缩写,以免造成歧义。但如果某个缩写在项目中使用且被理解,那么可以考虑使用。较短的单词可以通过去掉“元音”形成缩写;

(12)全局变量和局部变量首字母前增加G或者S进行区分;

(13)较长的单词可以取单词前几个字母形成缩写,一般取前三个字母;

(14)如果存在多个单词较长情况,一般取每个单词的首字母组成变量;

(15)多使用约定成俗的英文单词缩写

(16)命名中若使用特殊字符或者缩写,则应该在源文件开始处,对缩写进行说明。

3、enum、struct、union命名规则

enum(枚举)类型,前缀使用“e”+枚举变量名,其成员前缀为枚举变量或者其缩写;struct(结构体)类型,前缀使用“s”+结构体变量名,其成员和变量定义规则相同;union(联合)类型,前缀使用“u”+联合体变量名,其成员和变量定义规则相同;

4、函数命名规范

使用描述函数执行动作的动词,后跟能够清楚表达函数目的的名词。例如:calculateSum()、printMessage()。一般嵌入式编程需要加前缀,这个前缀一般是所在模块名字。

编辑:黄飞

猜您喜欢

贴片电阻规格对照表是电子工程师和爱好者必备的工具,它能够帮助你快速找到所需电阻的尺寸和封装信息。 面对密密麻麻的数字和代码,是不是感觉有些头疼?别担心,这篇介绍...
2025-04-14 15:02:40

NTC热敏电阻独特的温度感应能力,在众多温控设备中是不可少的配件。作为行业内的佼佼者,TT Electronics(英国)生产的NTC热敏电阻不仅在性能上遥遥领...
2012-01-23 00:22:22

压敏电阻独特的电压依赖电阻特性,在众多电路保护方案中占据了一席之地。其中,台康(TAICON)作为行业内的佼佼者,其压敏电阻产品凭借很好的性能和的应用范围,受到...
2015-07-25 22:02:41

本文中的测控系统是某型号无人机电子系统中的一个重要部分。为了对测控系统的改进优化设计进行验证,需要对软件进行长期运行考核,对该分系统进行单机验收与联试,验证其与...
2020-11-02 10:17:00

电阻作为电子元器件中的基础组件,其性能的优劣直接影响整个电路的稳定性和寿命。特别是在恶劣环境下工作的电子设备,防硫化电阻的需求日益增长。Walsin(华新)作为...
2019-07-29 22:06:30

应急警示棒是重要的安全设备,应用于交通、施工和紧急救援等场合。主要参数包括亮度、工作模式、续航时间和防水等级等。亮度是评估警示棒效果的关键参数,通常以流明(lm...
2011-06-07 00:00:00

在阅读本文之前,我们请读者牢记产业经济学上的三个要素:技术、成本与市场需求。因为在FPGA安全产品的应用进程中,始终离不开这三个支点。另外,我们也需要明确以下问...
2018-04-18 12:22:00

还在为查找贴片电阻值而烦恼吗?这款贴片电阻对照表下载软件将成为你的得力助手!它内置丰富的电阻值数据库,涵盖各种常见的贴片电阻封装尺寸和阻值范围。通过简洁直观的界...
2024-11-26 11:29:34

霍尔开关在吹风机中的应用与原理,主要是通过检测电机转子的位置和转速,实现风机的控制和调速。这种技术在目前的风机中得到了广泛的应用,并在提高风机性能和稳定性方面发...
2023-10-19 10:07:00

双向触发二极管(DB2)是应用于电子电路中的半导体器件,主要用于控制电流的开关和调节。由于其独特的工作原理和优良的性能,DB2被应用于电源管理、过电压保护和各种...
2025-04-09 21:31:10