代码编程规范-扩展(表达式和基本语句)

原创 大橙子疯嵌入式 2022-06-12 16:38

点击上方蓝色字体了解更多的嵌入式编程实用技能。
如果你觉得该文章对你有帮助,欢迎点赞+关注

前言

这篇重点介绍一下代码编程规范的扩展要求-表达式和基本语句规范要求

要求

【规范1】赋值语句不要写在if等语句中,或者作为函数的参数使用

因为if语句中,会根据条件依次判断,如果前一个条件已经可以判定整个条件,则后续条件语句不会再运行,所以可能导致期望的部分赋值没有得到运行
如:if (test == 15 || HandleLogicFun()) {...},此时若test = 15,则函数 HandleLogicFun就不会执行

【规范2】用括号明确表达式的操作顺序,避免过分依赖默认优先级

  • 使用括号强调所使用的操作符,防止因默认的优先级与设计思想不符而导致程序出错;

  • 同时使得代码更为清晰可读,然而过多的括号会分散代码使其降低了可读性。

  • 一般代码行的运算符比较多就需要,如果很简单必要性不大,反而降低了美观性


复合表达式

【规范1】不要编写太复杂的符合表达式

太复杂的符合表达式不利于代码阅读
i = a >= b && c < d && c + f <= g + h,过于复杂

【规范2】不要有多用途的符合表达式

d = (a = b + c) + r该表达式既求a值又求d值,应该拆分两个独立的语句:

a = b + c;
d = a + r;

if 语句

【规范1】布尔变量与零值比较

不可将布尔变量直接与TRUEFALSE或者10进行比较,虽然基本不会有什么大问题,但是会影响阅读性
根据布尔类型的语义,零值为“假” (记为FALSE) ,任何非零值都是“真” (记为TRUE) 。TRUE的值究竟是什么并没有统一的标准,例如 Visual C++  将TRUE定义为1,而 Visual Basic 则将TRUE定义为-1;因此对于布尔变量,它与零值比较的标准if语句如下:

if (flag)  // 表示 flag 为真
{
}

if (!flag) // 表示 flag 为假
{
}

【规范2】整型变量与零值比较

应当将整型变量用==!=直接与0比较。
对于整型变量,它与零值比较的标准if语句如下:

if (flag == 0)
{
}

if (flag != 0)
{
}

【规范3】浮点变量与零值比较

不可将浮点变量用==!=与任何数字比较。

千万要留意,无论是float还是double类型的变量,都有精度限制。所以一定要避免将浮点变量用==!=与数字比较,应该设法转化成>=<=形式。

假设浮点变量的名字为x,应当将if (x == 0.0)  // 隐含错误的比较转化为

if ((x >= -EPSINON) && (x <= EPSINON))
{
    ...
}

【规范4】指针变量与零值比较

应当将指针变量用==!=NULL比较,虽然和0比较基本不会有什么大问题,但是会影响阅读性,误以为该变量是其它类型
指针变量的零值是“空” (记为NULL) 。尽管NULL的值与0相同,但是两者意义不同。假设指针变量的名字为p,它与零值比较的标准if语句如下:

if (p == NULL// p 与 NULL 显式比较,强调 p 是指针变量
{
}

if (p != NULL
{
}

【规范5】若ifelse if分支,则必须有else分支

虽然没有else分支,但是在以后的代码维护中能清楚表明自己考虑了这种情况,但是目前不需要做任何处理

if (...)
{
    ...
}
else if (...)
{
    ...
}
else
{
    // TODO
}
 

其中表明注释 “TODO” 说明表明自己考虑了这种情况,但是目前不需要做任何处理

【规范6】对于if ("变量" == "常量")通常建议写成if ("常量" == "变量")

好处时能避免粗心大意写成if ("变量" = "常量"),而编译可能不会报错,最终代码运行时就会出现异常,而if ("常量" == "变量")这种写法若少了=,根据常量不能被赋值的规则,编译时就会报错。
当然这种写法可能不美观,如果强迫症,那建议养成习惯后可以再恢复if ("变量" = "常量")这种写法,因为写该语句时都会下意识想到该规则,从而避免少写=,也能避免粗心引起的该问题。

if (5 == test)
{
}

if (NULL == pTest)
{
}

for/while/do 循环语句

循环语句有for语句,while语句,do语句,其中for语句是使用频率最高的,以下规范1、2介绍如何提高for循环语句的效率,其根本是降低循环体的复杂性。


【规范1】在多重循环中,如果有可能,应当将最长的循环放在最内层,最短的循环放在最外层,以减少CPU跨切循环层的次数

其中第二种就比第一种的运行效率要高,光从C代码角度看,区别不大,这个需要从汇编的角度看才能明显看出,具体可以自行尝试看执行时间(循环次数足够)看或者网上百度两种方式的对比,这里不再描述,网上比较详细;不过我建议是直接看两种编译后的汇编语句,这样感触最深。

// 第一种
for (i = 0; i < 100; i++)
{
    for (j = 0; j < 10; j++)
    {
        ...
    }
}

// 第二种
for (i = 0; i < 10; i++)
{
    for (j = 0; j < 100; j++)
    {
        ...
    }
}

【规范2】循环中存在判断语句等,根据实际情况选择

如以下代码中判断表达式在循环体中,第二种就效率来说比第一种高,但是就代码简洁性来看,第一种更好,那么如何取舍呢?

  1. 循环次数较少,可以采用第一种,原因是在循环次数较少的情况下,第二种的效率提高不明显

  2. 底层驱动开发时,采用第一种往往会极大地影响效率,所以普遍采用第二种(之前开发LCD驱动时,画点时第二种比第一种在速度上明显提高)

// 第一种
for (i = 0; i < 10; i++)
{
    if (...)
    {
        ...
    }
    else
    {
        ...
    }
}

// 第二种
if (...)
{
    for (i = 0; i < 10; i++)
    {
        ...
    }
}
else
{
    for (i = 0; i < 10; i++)
    {
        ...
    }
}

【规范3】不能再for循环体内修改循环变量,防止for循环失去控制

下列代码容易失去控制

for (i = 0; i < 10; i++)
{
    if (...)
    {
        i += 2;
    }
    else
    {
        ...;
    }
}

【规范4】建议for循环控制变量的取值采用“半开半闭区间”原则

以下两种方式功能一样,但是第一种的写法更加直观

// 第一种
for (i = 0; i < N; i++)
{
    ...
}

// 第二种
for (i = 0; i <= N - 1; i++)
{
    ...
}

【规范5】空循环也应该使用{}或者continue,而不是一个简单的分号

这样做的目的是直观地看出是一个空循环体

for (i = 0; i < N; i++)
{
}

while (flag)
{
    condition;
}

switch 语句

【规范1】每一个switch语句最后都要写default分支,即使什么也不做

这个和else ifelse分支规则一样,目的是在以后的代码维护中能清楚表明自己考虑了这种情况,但是目前不需要做任何处理

【规范2】每个case语句的结尾别忘记加break,否则导致多个分支重叠,除非是有意使多个分支重叠

建议casebreak成对编写,不要写了其他语句再写break,防止遗忘,即使有意重叠,也应该这样做,写完后再删除break


goto语句

【规范1】尽量少用,但是我建议禁用更好,对于程序的阅读有很大的阻碍,如果必要可以采用 do{...}while(0)的方式替代

一般情况goto能解决退出函数时需要做的处理,如打开文件中间出现错误都需要关闭文件,不需要再退出的地方都写

int ReadFileDate(char *pBuf, uint16_t lenth)
{
    if (NULL == pBuf || 0 == lenth)
    {
        return;
    }

    if (open(file) == -1)
    {
        goto EOF;
    }

    if (read(file, pBuf, lenth) == -1)
    {
        goto EOF;
    }

    ...  // 其他处理,可能也存在错误需要退出处理(因为已经打开文件了)

EOF:
    close(file);
}
 


这种方式如果禁用goto,则基本每一个退出函数的地方都需要close反而麻烦,此时可以通过do{...}while(0)的方式替代

int ReadFileDate(char *pBuf, uint16_t lenth)
{
    if (NULL == pBuf || 0 == lenth)
    {
        return;
    }

    do
    {
        if (open(file) == -1)
        {
            break;
        }

        if (read(file, pBuf, lenth) == -1)
        {
            break;
        }

        ...  // 其他处理,可能也存在错误需要退出处理(因为已经打开文件了)
    } while (0);

    close(file);
}

评论
  • 随着市场需求不断的变化,各行各业对CPU的要求越来越高,特别是近几年流行的 AIOT,为了有更好的用户体验,CPU的算力就要求更高了。今天为大家推荐由米尔基于瑞芯微RK3576处理器推出的MYC-LR3576核心板及开发板。关于RK3576处理器国产CPU,是这些年的骄傲,华为手机全国产化,国人一片呼声,再也不用卡脖子了。RK3576处理器,就是一款由国产是厂商瑞芯微,今年第二季推出的全新通用型的高性能SOC芯片,这款CPU到底有多么的高性能,下面看看它的几个特性:8核心6 TOPS超强算力双千
    米尔电子嵌入式 2025-01-03 17:04 55浏览
  • 每日可见的315MHz和433MHz遥控模块,你能分清楚吗?众所周知,一套遥控设备主要由发射部分和接收部分组成,发射器可以将控制者的控制按键经过编码,调制到射频信号上面,然后经天线发射出无线信号。而接收器是将天线接收到的无线信号进行解码,从而得到与控制按键相对应的信号,然后再去控制相应的设备工作。当前,常见的遥控设备主要分为红外遥控与无线电遥控两大类,其主要区别为所采用的载波频率及其应用场景不一致。红外遥控设备所采用的射频信号频率一般为38kHz,通常应用在电视、投影仪等设备中;而无线电遥控设备
    华普微HOPERF 2025-01-06 15:29 127浏览
  • 根据Global Info Research项目团队最新调研,预计2030年全球封闭式电机产值达到1425百万美元,2024-2030年期间年复合增长率CAGR为3.4%。 封闭式电机是一种电动机,其外壳设计为密闭结构,通常用于要求较高的防护等级的应用场合。封闭式电机可以有效防止外部灰尘、水分和其他污染物进入内部,从而保护电机的内部组件,延长其使用寿命。 环洋市场咨询机构出版的调研分析报告【全球封闭式电机行业总体规模、主要厂商及IPO上市调研报告,2025-2031】研究全球封闭式电机总体规
    GIRtina 2025-01-06 11:10 104浏览
  • 这篇内容主要讨论三个基本问题,硅电容是什么,为什么要使用硅电容,如何正确使用硅电容?1.  硅电容是什么首先我们需要了解电容是什么?物理学上电容的概念指的是给定电位差下自由电荷的储藏量,记为C,单位是F,指的是容纳电荷的能力,C=εS/d=ε0εrS/4πkd(真空)=Q/U。百度百科上电容器的概念指的是两个相互靠近的导体,中间夹一层不导电的绝缘介质。通过观察电容本身的定义公式中可以看到,在各个变量中比较能够改变的就是εr,S和d,也就是介质的介电常数,金属板有效相对面积以及距离。当前
    知白 2025-01-06 12:04 173浏览
  • 本文介绍Linux系统更换开机logo方法教程,通用RK3566、RK3568、RK3588、RK3576等开发板,触觉智能RK3562开发板演示,搭载4核A53处理器,主频高达2.0GHz;内置独立1Tops算力NPU,可应用于物联网网关、平板电脑、智能家居、教育电子、工业显示与控制等行业。制作图片开机logo图片制作注意事项(1)图片必须为bmp格式;(2)图片大小不能大于4MB;(3)BMP位深最大是32,建议设置为8;(4)图片名称为logo.bmp和logo_kernel.bmp;开机
    Industio_触觉智能 2025-01-06 10:43 87浏览
  • 根据环洋市场咨询(Global Info Research)项目团队最新调研,预计2030年全球无人机锂电池产值达到2457百万美元,2024-2030年期间年复合增长率CAGR为9.6%。 无人机锂电池是无人机动力系统中存储并释放能量的部分。无人机使用的动力电池,大多数是锂聚合物电池,相较其他电池,锂聚合物电池具有较高的能量密度,较长寿命,同时也具有良好的放电特性和安全性。 全球无人机锂电池核心厂商有宁德新能源科技、欣旺达、鹏辉能源、深圳格瑞普和EaglePicher等,前五大厂商占有全球
    GIRtina 2025-01-07 11:02 68浏览
  • By Toradex 秦海1). 简介嵌入式平台设备基于Yocto Linux 在开发后期量产前期,为了安全以及提高启动速度等考虑,希望将 ARM 处理器平台的 Debug Console 输出关闭,本文就基于 NXP i.MX8MP ARM 处理器平台来演示相关流程。 本文所示例的平台来自于 Toradex Verdin i.MX8MP 嵌入式平台。  2. 准备a). Verdin i.MX8MP ARM核心版配合Dahlia载板并
    hai.qin_651820742 2025-01-07 14:52 45浏览
  • 在智能家居领域中,Wi-Fi、蓝牙、Zigbee、Thread与Z-Wave等无线通信协议是构建短距物联局域网的关键手段,它们常在实际应用中交叉运用,以满足智能家居生态系统多样化的功能需求。然而,这些协议之间并未遵循统一的互通标准,缺乏直接的互操作性,在进行组网时需要引入额外的网关作为“翻译桥梁”,极大地增加了系统的复杂性。 同时,Apple HomeKit、SamSung SmartThings、Amazon Alexa、Google Home等主流智能家居平台为了提升市占率与消费者
    华普微HOPERF 2025-01-06 17:23 145浏览
  • 村田是目前全球量产硅电容的领先企业,其在2016年收购了法国IPDiA头部硅电容器公司,并于2023年6月宣布投资约100亿日元将硅电容产能提升两倍。以下内容主要来自村田官网信息整理,村田高密度硅电容器采用半导体MOS工艺开发,并使用3D结构来大幅增加电极表面,因此在给定的占位面积内增加了静电容量。村田的硅技术以嵌入非结晶基板的单片结构为基础(单层MIM和多层MIM—MIM是指金属 / 绝缘体/ 金属) 村田硅电容采用先进3D拓扑结构在100um内,使开发的有效静电容量面积相当于80个
    知白 2025-01-07 15:02 75浏览
  • 大模型的赋能是指利用大型机器学习模型(如深度学习模型)来增强或改进各种应用和服务。这种技术在许多领域都显示出了巨大的潜力,包括但不限于以下几个方面: 1. 企业服务:大模型可以用于构建智能客服系统、知识库问答系统等,提升企业的服务质量和运营效率。 2. 教育服务:在教育领域,大模型被应用于个性化学习、智能辅导、作业批改等,帮助教师减轻工作负担,提高教学质量。 3. 工业智能化:大模型有助于解决工业领域的复杂性和不确定性问题,尽管在认知能力方面尚未完全具备专家级的复杂决策能力。 4. 消费
    丙丁先生 2025-01-07 09:25 80浏览
  • 彼得·德鲁克被誉为“现代管理学之父”,他的管理思想影响了无数企业和管理者。然而,关于他的书籍分类,一种流行的说法令人感到困惑:德鲁克一生写了39本书,其中15本是关于管理的,而其中“专门写工商企业或为企业管理者写的”只有两本——《为成果而管理》和《创新与企业家精神》。这样的表述广为流传,但深入探讨后却发现并不完全准确。让我们一起重新审视这一说法,解析其中的矛盾与根源,进而重新认识德鲁克的管理思想及其著作的真正价值。从《创新与企业家精神》看德鲁克的视角《创新与企业家精神》通常被认为是一本专为企业管
    优思学院 2025-01-06 12:03 119浏览
  • PLC组态方式主要有三种,每种都有其独特的特点和适用场景。下面来简单说说: 1. 硬件组态   定义:硬件组态指的是选择适合的PLC型号、I/O模块、通信模块等硬件组件,并按照实际需求进行连接和配置。    灵活性:这种方式允许用户根据项目需求自由搭配硬件组件,具有较高的灵活性。    成本:可能需要额外的硬件购买成本,适用于对系统性能和扩展性有较高要求的场合。 2. 软件组态   定义:软件组态主要是通过PLC
    丙丁先生 2025-01-06 09:23 85浏览
  •     为控制片内设备并且查询其工作状态,MCU内部总是有一组特殊功能寄存器(SFR,Special Function Register)。    使用Eclipse环境调试MCU程序时,可以利用 Peripheral Registers Viewer来查看SFR。这个小工具是怎样知道某个型号的MCU有怎样的寄存器定义呢?它使用一种描述性的文本文件——SVD文件。这个文件存储在下面红色字体的路径下。    例:南京沁恒  &n
    电子知识打边炉 2025-01-04 20:04 100浏览
我要评论
0
点击右上角,分享到朋友圈 我知道啦
请使用浏览器分享功能 我知道啦