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

原创 大橙子疯嵌入式 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);
}

评论
  • 在物联网领域中,无线射频技术作为设备间通信的核心手段,已深度渗透工业自动化、智慧城市及智能家居等多元场景。然而,随着物联网设备接入规模的不断扩大,如何降低运维成本,提升通信数据的传输速度和响应时间,实现更广泛、更稳定的覆盖已成为当前亟待解决的系统性难题。SoC无线收发模块-RFM25A12在此背景下,华普微创新推出了一款高性能、远距离与高性价比的Sub-GHz无线SoC收发模块RFM25A12,旨在提升射频性能以满足行业中日益增长与复杂的设备互联需求。值得一提的是,RFM25A12还支持Wi-S
    华普微HOPERF 2025-02-28 09:06 143浏览
  • 在2024年的科技征程中,具身智能的发展已成为全球关注的焦点。从实验室到现实应用,这一领域正以前所未有的速度推进,改写着人类与机器的互动边界。这一年,我们见证了具身智能技术的突破与变革,它不仅落地各行各业,带来新的机遇,更在深刻影响着我们的生活方式和思维方式。随着相关技术的飞速发展,具身智能不再仅仅是一个技术概念,更像是一把神奇的钥匙。身后的众多行业,无论愿意与否,都像是被卷入一场伟大变革浪潮中的船只,注定要被这股汹涌的力量重塑航向。01为什么是具身智能?为什么在中国?最近,中国具身智能行业的进
    艾迈斯欧司朗 2025-02-28 15:45 221浏览
  • 振动样品磁强计是一种用于测量材料磁性的精密仪器,广泛应用于科研、工业检测等领域。然而,其测量准确度会受到多种因素的影响,下面我们将逐一分析这些因素。一、温度因素温度是影响振动样品磁强计测量准确度的重要因素之一。随着温度的变化,材料的磁性也会发生变化,从而影响测量结果的准确性。因此,在进行磁性测量时,应确保恒温环境,以减少温度波动对测量结果的影响。二、样品制备样品的制备过程同样会影响振动样品磁强计的测量准确度。样品的形状、尺寸和表面处理等因素都会对测量结果产生影响。为了确保测量准确度,应严格按照规
    锦正茂科技 2025-02-28 14:05 134浏览
  • RGB灯光无法同步?细致的动态光效设定反而成为产品客诉来源!随着科技的进步和消费者需求变化,电脑接口设备单一功能性已无法满足市场需求,因此在产品上增加「动态光效」的形式便应运而生,藉此吸引消费者目光。这种RGB灯光效果,不仅能增强电脑周边产品的视觉吸引力,还能为用户提供个性化的体验,展现独特自我风格。如今,笔记本电脑、键盘、鼠标、鼠标垫、耳机、显示器等多种电脑接口设备多数已配备动态光效。这些设备的灯光效果会随着音乐节奏、游戏情节或使用者的设置而变化。想象一个画面,当一名游戏玩家,按下电源开关,整
    百佳泰测试实验室 2025-02-27 14:15 137浏览
  •           近日受某专业机构邀请,参加了官方举办的《广东省科技创新条例》宣讲会。在与会之前,作为一名技术工作者一直认为技术的法例都是保密和侵权方面的,而潜意识中感觉法律有束缚创新工作的进行可能。通过一个上午学习新法,对广东省的科技创新有了新的认识。广东是改革的前沿阵地,是科技创新的沃土,企业是创新的主要个体。《广东省科技创新条例》是广东省为促进科技创新、推动高质量发展而制定的地方性法规,主要内容包括: 总则:明确立法目
    广州铁金刚 2025-02-28 10:14 103浏览
  •         近日,广电计量在聚焦离子束(FIB)领域编写的专业著作《聚焦离子束:失效分析》正式出版,填补了国内聚焦离子束领域实践性专业书籍的空白,为该领域的技术发展与知识传播提供了重要助力。         随着芯片技术不断发展,芯片的集成度越来越高,结构也日益复杂。这使得传统的失效分析方法面临巨大挑战。FIB技术的出现,为芯片失效分析带来了新的解决方案。它能够在纳米尺度上对芯片进行精确加工和分析。当芯
    广电计量 2025-02-28 09:15 116浏览
  • 美国加州CEC能效跟DOE能效有什么区别?CEC/DOE是什么关系?美国加州CEC能效跟DOE能效有什么区别?CEC/DOE是什么关系?‌美国加州CEC能效认证与美国DOE能效认证在多个方面存在显著差异‌。认证范围和适用地区‌CEC能效认证‌:仅适用于在加利福尼亚州销售的电器产品。CEC认证的范围包括制冷设备、房间空调、中央空调、便携式空调、加热器、热水器、游泳池加热器、卫浴配件、光源、应急灯具、交通信号模块、灯具、洗碗机、洗衣机、干衣机、烹饪器具、电机和压缩机、变压器、外置电源、消费类电子设备
    张工nx808593 2025-02-27 18:04 120浏览
  • 1,微软下载免费Visual Studio Code2,安装C/C++插件,如果无法直接点击下载, 可以选择手动install from VSIX:ms-vscode.cpptools-1.23.6@win32-x64.vsix3,安装C/C++编译器MniGW (MinGW在 Windows 环境下提供类似于 Unix/Linux 环境下的开发工具,使开发者能够轻松地在 Windows 上编写和编译 C、C++ 等程序.)4,C/C++插件扩展设置中添加Include Path 5,
    黎查 2025-02-28 14:39 140浏览
  • 一、VSM的基本原理震动样品磁强计(Vibrating Sample Magnetometer,简称VSM)是一种灵敏且高效的磁性测量仪器。其基本工作原理是利用震动样品在探测线圈中引起的变化磁场来产生感应电压,这个感应电压与样品的磁矩成正比。因此,通过测量这个感应电压,我们就能够精确地确定样品的磁矩。在VSM中,被测量的样品通常被固定在一个震动头上,并以一定的频率和振幅震动。这种震动在探测线圈中引起了变化的磁通量,从而产生了一个交流电信号。这个信号的幅度和样品的磁矩有着直接的关系。因此,通过仔细
    锦正茂科技 2025-02-28 13:30 100浏览
  • 应用趋势与客户需求,AI PC的未来展望随着人工智能(AI)技术的日益成熟,AI PC(人工智能个人电脑)逐渐成为消费者和企业工作中的重要工具。这类产品集成了最新的AI处理器,如NPU、CPU和GPU,并具备许多智能化功能,为用户带来更高效且直观的操作体验。AI PC的目标是提升工作和日常生活的效率,通过深度学习与自然语言处理等技术,实现更流畅的多任务处理、实时翻译、语音助手、图像生成等功能,满足现代用户对生产力和娱乐的双重需求。随着各行各业对数字转型需求的增长,AI PC也开始在各个领域中显示
    百佳泰测试实验室 2025-02-27 14:08 255浏览
  • 更多生命体征指标风靡的背后都只有一个原因:更多人将健康排在人生第一顺位!“AGEs,也就是晚期糖基化终末产物,英文名Advanced Glycation End-products,是存在于我们体内的一种代谢产物” 艾迈斯欧司朗亚太区健康监测高级市场经理王亚琴说道,“相信业内的朋友都会有关注,最近该指标的热度很高,它可以用来评估人的生活方式是否健康。”据悉,AGEs是可穿戴健康监测领域的一个“萌新”指标,近来备受关注。如果站在学术角度来理解它,那么AGEs是在非酶促条件下,蛋白质、氨基酸
    艾迈斯欧司朗 2025-02-27 14:50 400浏览
我要评论
0
点击右上角,分享到朋友圈 我知道啦
请使用浏览器分享功能 我知道啦