EEPW论坛

下面小编再共享一下常用的软件编码的规范和技巧：

编程中其实比较头痛的一件事就是定义变量到词穷，编写出看似很专业的软件其实最重要的是变量命名的方法套路，接下来就教教你怎么快速进行变量和函数的命名。

命名原则

首先要保证一个原则，一定要和公司或者项目的代码规范统一，其次要保证编码命名的简洁、望文知义。这样做的目的就是为了协作开发和后期还能够快速而准确地理解自己的程序。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）多使用约定成俗的英文单词缩写；在本公众号内回复【英语单词】可以获取小编整理的近800个单词的常用缩写。（16）命名中若使用特殊字符或者缩写，则应该在源文件开始处，对缩写进行说明。3、enum、struct、union命名规则enum（枚举）类型，前缀使用“e”+枚举变量名，其成员前缀为枚举变量或者其缩写；struct(结构体)类型，前缀使用“s”+结构体变量名，其成员和变量定义规则相同；union(联合)类型，前缀使用“u”+联合体变量名，其成员和变量定义规则相同；4、函数命名规范使用描述函数执行动作的动词，后跟能够清楚表达函数目的的名词。例如：calculateSum()、printMessage()。一般嵌入式编程需要加前缀，这个前缀一般是所在模块名字。