为什么你的Code,很难看?

嵌入式ARM 2023-08-23 12:01

前段时间分享了常用单词的缩写cfg】" linktype="text" imgurl="" imgdata="null" data-itemshowtype="0" tab="innerlink" data-linktype="2" style="letter-spacing: 0.034em; font-size: 16px;">【总结了近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)多使用约定成俗的英文单词缩写;在本公众号内回复【英语单词】可以获取小编整理的近800个单词的常用缩写。
(16)命名中若使用特殊字符或者缩写,则应该在源文件开始处,对缩写进行说明。
3、enum、struct、union命名规则
enum(枚举)类型,前缀使用“e”+枚举变量名,其成员前缀为枚举变量或者其缩写。
struct(结构体)类型,前缀使用“s”+结构体变量名,其成员和变量定义规则相同。
union联合)类型,前缀使用“u”+联合体变量名,其成员和变量定义规则相同。
4、函数命名规范
使用描述函数执行动作的动词,后跟能够清楚表达函数目的的名词。例如:calculateSum()、printMessage()。一般嵌入式编程需要加前缀,这个前缀一般是所在模块名字。

END

来源:玩转单片机与嵌入式

版权归原作者所有,如有侵权,请联系删除。

推荐阅读
C语言,环形队列
嵌入式开发,要不要接私活?
世界上最流行的软件,抛弃了Git

→点关注,不迷路←

嵌入式ARM 关注这个时代最火的嵌入式ARM,你想知道的都在这里。
评论
  • 最近几年,新能源汽车愈发受到消费者的青睐,其销量也是一路走高。据中汽协公布的数据显示,2024年10月,新能源汽车产销分别完成146.3万辆和143万辆,同比分别增长48%和49.6%。而结合各家新能源车企所公布的销量数据来看,比亚迪再度夺得了销冠宝座,其10月新能源汽车销量达到了502657辆,同比增长66.53%。众所周知,比亚迪是新能源汽车领域的重要参与者,其一举一动向来为外界所关注。日前,比亚迪汽车旗下品牌方程豹汽车推出了新车方程豹豹8,该款车型一上市就迅速吸引了消费者的目光,成为SUV
    刘旷 2024-12-02 09:32 119浏览
  • RDDI-DAP错误通常与调试接口相关,特别是在使用CMSIS-DAP协议进行嵌入式系统开发时。以下是一些可能的原因和解决方法: 1. 硬件连接问题:     检查调试器(如ST-Link)与目标板之间的连接是否牢固。     确保所有必要的引脚都已正确连接,没有松动或短路。 2. 电源问题:     确保目标板和调试器都有足够的电源供应。     检查电源电压是否符合目标板的规格要求。 3. 固件问题: &n
    丙丁先生 2024-12-01 17:37 102浏览
  • 当前,智能汽车产业迎来重大变局,随着人工智能、5G、大数据等新一代信息技术的迅猛发展,智能网联汽车正呈现强劲发展势头。11月26日,在2024紫光展锐全球合作伙伴大会汽车电子生态论坛上,紫光展锐与上汽海外出行联合发布搭载紫光展锐A7870的上汽海外MG量产车型,并发布A7710系列UWB数字钥匙解决方案平台,可应用于数字钥匙、活体检测、脚踢雷达、自动泊车等多种智能汽车场景。 联合发布量产车型,推动汽车智能化出海紫光展锐与上汽海外出行达成战略合作,联合发布搭载紫光展锐A7870的量产车型
    紫光展锐 2024-12-03 11:38 101浏览
  • TOF多区传感器: ND06   ND06是一款微型多区高集成度ToF测距传感器,其支持24个区域(6 x 4)同步测距,测距范围远达5m,具有测距范围广、精度高、测距稳定等特点。适用于投影仪的无感自动对焦和梯形校正、AIoT、手势识别、智能面板和智能灯具等多种场景。                 如果用ND06进行手势识别,只需要经过三个步骤: 第一步&
    esad0 2024-12-04 11:20 58浏览
  • 概述 说明(三)探讨的是比较器一般带有滞回(Hysteresis)功能,为了解决输入信号转换速率不够的问题。前文还提到,即便使能滞回(Hysteresis)功能,还是无法解决SiPM读出测试系统需要解决的问题。本文在说明(三)的基础上,继续探讨为SiPM读出测试系统寻求合适的模拟脉冲检出方案。前四代SiPM使用的高速比较器指标缺陷 由于前端模拟信号属于典型的指数脉冲,所以下降沿转换速率(Slew Rate)过慢,导致比较器检出出现不必要的问题。尽管比较器可以使能滞回(Hysteresis)模块功
    coyoo 2024-12-03 12:20 111浏览
  • 作为优秀工程师的你,已身经百战、阅板无数!请先醒醒,新的项目来了,这是一个既要、又要、还要的产品需求,ARM核心板中一个处理器怎么能实现这么丰富的外围接口?踌躇之际,你偶阅此文。于是,“潘多拉”的魔盒打开了!没错,USB资源就是你打开新世界得钥匙,它能做哪些扩展呢?1.1  USB扩网口通用ARM处理器大多带两路网口,如果项目中有多路网路接口的需求,一般会选择在主板外部加交换机/路由器。当然,出于成本考虑,也可以将Switch芯片集成到ARM核心板或底板上,如KSZ9897、
    万象奥科 2024-12-03 10:24 68浏览
  • 光伏逆变器是一种高效的能量转换设备,它能够将光伏太阳能板(PV)产生的不稳定的直流电压转换成与市电频率同步的交流电。这种转换后的电能不仅可以回馈至商用输电网络,还能供独立电网系统使用。光伏逆变器在商业光伏储能电站和家庭独立储能系统等应用领域中得到了广泛的应用。光耦合器,以其高速信号传输、出色的共模抑制比以及单向信号传输和光电隔离的特性,在光伏逆变器中扮演着至关重要的角色。它确保了系统的安全隔离、干扰的有效隔离以及通信信号的精准传输。光耦合器的使用不仅提高了系统的稳定性和安全性,而且由于其低功耗的
    晶台光耦 2024-12-02 10:40 120浏览
  • 遇到部分串口工具不支持1500000波特率,这时候就需要进行修改,本文以触觉智能RK3562开发板修改系统波特率为115200为例,介绍瑞芯微方案主板Linux修改系统串口波特率教程。温馨提示:瑞芯微方案主板/开发板串口波特率只支持115200或1500000。修改Loader打印波特率查看对应芯片的MINIALL.ini确定要修改的bin文件#查看对应芯片的MINIALL.ini cat rkbin/RKBOOT/RK3562MINIALL.ini修改uart baudrate参数修改以下目
    Industio_触觉智能 2024-12-03 11:28 87浏览
  •         温度传感器的精度受哪些因素影响,要先看所用的温度传感器输出哪种信号,不同信号输出的温度传感器影响精度的因素也不同。        现在常用的温度传感器输出信号有以下几种:电阻信号、电流信号、电压信号、数字信号等。以输出电阻信号的温度传感器为例,还细分为正温度系数温度传感器和负温度系数温度传感器,常用的铂电阻PT100/1000温度传感器就是正温度系数,就是说随着温度的升高,输出的电阻值会增大。对于输出
    锦正茂科技 2024-12-03 11:50 111浏览
  • 11-29学习笔记11-29学习笔记习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习笔记&记录学习习笔记&记学习学习笔记&记录学习学习笔记&记录学习习笔记&记录学习学习笔记&记录学习学习笔记记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&学习学习笔记&记录学习学习笔记&记录学习学习笔记&记
    youyeye 2024-12-02 23:58 73浏览
我要评论
0
点击右上角,分享到朋友圈 我知道啦
请使用浏览器分享功能 我知道啦