代码编程规范-排版风格,提升你代码逼格的小技巧

嵌入式ARM 2022-04-26 12:00

如果你觉得该文章对你有帮助,欢迎点赞+关注

前言

这篇重点介绍一下代码编程的排版风格和自动排版工具

代码规范化中的排版基本上有七大风格,主要体现在缩进、空行、代码行、空格、成对书写、对齐、注释七方面的书写规范上。

规范要求

缩进

程序块采用缩进风格编写,缩进可以使程序更有层次感,每次缩进一般为 4 个空格(部分要求为一个制表符Tab;我个人喜欢用空格,因为制表符不同编辑器缩进不同,虽然能设置,但是麻烦)

原则是:如果地位相等,则不需要缩进;如果属于某一个代码的内部代码就需要缩进


空行

空行起着分隔程序段落的作用。空行得体将使程序的布局更加清晰。空行不会浪费内存,虽然在文档中比较多,但是值得

  1. 定义变量后要空行。尽可能在定义变量的同时初始化该变量,即遵循就近原则;如果变量的引用和定义相隔比较远,那么变量的初始化就很容易被忘记。若引用了未被初始化的变量,就会导致程序出错

  2. 每个函数定义结束之后都要加空行

  3. 结合1、2两点综合来说,相对独立的程序块之间、变量说明之后必须加空行。比如上面几行代码完成的是一个功能,下面几行代码完成的是另一个功能,那么它们中间就要加空行。这样看起来更清晰

 1isFoo = true;
2// 空行
3if (isFoo) 
4{
5    bar();
6
7else 
8{
9    anotherBar();
10}
11// 空行
12isBar = false;

代码行

  1. 一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且便于写注释

  2. iffordowhilecaseswitchdefault等语句独占一行,执行语句不得紧跟其后

不论执行语句有多少行,就算只有一行也要加{},并且遵循对齐的原则,这样可以防止书写失误

  1. 一条语句不能过长,如不能拆分需要分行写,对于目前大多数的PC来说,132 比较合适(80/132是VTY常见的行宽值)

对于新PC宽屏显示器较多的产品来说,可以设置更大的值; 且目前的软件大多都能设置并显示这个宽度的提示线

1// 错误示范
2if (...){...}
3
4// 正确示范
5if (...)
6{
7    ...
8}

空格

  1. 关键字之后要留空格。像 constcase 等关键字之后至少要留一个空格,否则无法辨析关键字。像 ifforwhile 等关键字之后应留一个空格再跟左括号(,以突出关键字

1// 错误示范
2if(...)
3
4// 正确示范
5if (...)

  1. 函数名之后不要留空格,应紧跟左括号(,以与关键字区别

1// 错误示范
2void move (char *buf, uint32_t length);
3
4// 正确示范
5void move(char *buf, uint32_t length);

  1. (向后紧跟;),;这三个向前紧跟;紧跟处不留空格

1// 错误示范
2move ( buf , 35 ) ;
3
4// 正确示范
5move(buf, 35);

  1. ,之后要留空格。如果;不是一行的结束符号,其后要留空格

1// 错误示范
2move(buf,35);
3
4// 正确示范
5move(buf, 35);

  1. 赋值运算符、关系运算符、算术运算符、逻辑运算符、位运算符,如 ===!=+=-==`、`/=`、`%=`、`>>=`、`<<=`、`&=`、`^=`、`|=`、`<`、`<=`、`>`、`>=`、`+`、`-`、`/%&;|&&||<<>>;^ 等双目运算符的前后应当加空格(运算符“%”是求余运算符,与 printf%d“%”不同,所以 %d 中的“%”前后不用加空格)

1// 错误示范
2num+=5;
3hex=hex&0x05;
4printf("% d", num);
5
6// 正确示范
7num += 5;
8hex = hex & 0x05;
9printf("%d", num);

  1. 单目运算符 !~++--*& 等前后不需要加空格

1// 错误示范
2cnt ++;
3boolVal = ! boolVal;
4
5// 正确示范
6cnt++;
7boolVal = !boolVal;

  1. 像数组符号[]、结构体成员运算符.、和指向结构体成员运算符->,这类操作符前后不加空格

1// 错误示范
2char buf [ 50 ];
3tInfo -> mem = 0;
4
5// 正确示范
6char buf[50];
7tInfo->mem = 0;

  1. 对于表达式比较长的for语句和if语句,为了紧凑起见,可以适当地去掉一些空格。但 forif 后面紧跟的空格不可以删,其后面的语句可以根据语句的长度适当地去掉一些空格。例如:for (i=0; i<10; i++),即for和分号后面保留空格,=< 前后的空格去掉


成对书写

成对的符号一定要成对书写,如 (){}。不要写完左括号然后写内容最后再补右括号,这样很容易漏掉右括号,尤其是写嵌套程序的时候。


对齐

对齐主要是针对大括号{}说的

  1. {}分别都要独占一行。互为一对的{}要位于同一列,并且与引用它们的语句左对齐

  2. { }之内的代码要向内一个缩进,且同一地位的要左对齐,地位不同的继续缩进

 1// 错误示范
2int main(void){
3int val = 0;
4}
5
6// 正确示范
7// 错误示范
8int main(void)
9
{
10    int val = 0;
11}

注释

C语言中一行注释一般采用//…,多行注释必须采用 /*…*/。注释通常用于重要的代码行或段落提示。在一般情况下,源程序有效注释量必须在 20% 以上。虽然注释有助于理解代码,但注意不可过多地使用注释,注释太多会让人眼花缭乱。

  1. 注释用使用对代码的功能做解释,并不是说明是怎么做的

  2. 对于一些巧妙地、用特殊方式实现功能的代码,可以使用注释说明这样做的目的或好处等

  3. 代码十分明确的,一目了然的,则不必增加注释,否则就是多余的注释,如 int minValue = 5; // 定义最小值为5

  4. 边写代码边注释,修改代码的同时要修改相应的注释,以保证注释与代码的一致性,不再有用的注释要删除

  5. 每一条宏定义的右边必须要有注释,说明其作用

  6. 相关函数和结构体等需要注释,具体注释方式请参考文档中的“注释规范”内容

排版工具


嵌入式软件开发常用软件中提到的源格式化工具Astyle,官网地址
http://astyle.sourceforge.net/

Astyle 是一个开源的源码格式化工具插件,可以集成在 KEIL、IAR 或者文本编辑器等多款软件中,作为一个脚本自动格式话代码风格,十分方便。
根据上述排版风格,我设置的指令是:
--style=allman -t -xV -C -f -p -H -k3 -y -xb -j -U %f

如下图,随便打开一个糟糕的代码文件,通过 KEIL 集成的 Astyle工具自动格式化代码风格。


来源:大橙子疯嵌入式


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

推荐阅读
资深嵌入式软件工程师推荐这些开发工具,效率倍增!
嵌入式 C 中的五大实用技巧分享
代码调着调着就失联了???

→点关注,不迷路←

嵌入式ARM 关注这个时代最火的嵌入式ARM,你想知道的都在这里。
评论
  • 每日可见的315MHz和433MHz遥控模块,你能分清楚吗?众所周知,一套遥控设备主要由发射部分和接收部分组成,发射器可以将控制者的控制按键经过编码,调制到射频信号上面,然后经天线发射出无线信号。而接收器是将天线接收到的无线信号进行解码,从而得到与控制按键相对应的信号,然后再去控制相应的设备工作。当前,常见的遥控设备主要分为红外遥控与无线电遥控两大类,其主要区别为所采用的载波频率及其应用场景不一致。红外遥控设备所采用的射频信号频率一般为38kHz,通常应用在电视、投影仪等设备中;而无线电遥控设备
    华普微HOPERF 2025-01-06 15:29 127浏览
  • 本文介绍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浏览
  • 大模型的赋能是指利用大型机器学习模型(如深度学习模型)来增强或改进各种应用和服务。这种技术在许多领域都显示出了巨大的潜力,包括但不限于以下几个方面: 1. 企业服务:大模型可以用于构建智能客服系统、知识库问答系统等,提升企业的服务质量和运营效率。 2. 教育服务:在教育领域,大模型被应用于个性化学习、智能辅导、作业批改等,帮助教师减轻工作负担,提高教学质量。 3. 工业智能化:大模型有助于解决工业领域的复杂性和不确定性问题,尽管在认知能力方面尚未完全具备专家级的复杂决策能力。 4. 消费
    丙丁先生 2025-01-07 09:25 80浏览
  • 根据Global Info Research项目团队最新调研,预计2030年全球封闭式电机产值达到1425百万美元,2024-2030年期间年复合增长率CAGR为3.4%。 封闭式电机是一种电动机,其外壳设计为密闭结构,通常用于要求较高的防护等级的应用场合。封闭式电机可以有效防止外部灰尘、水分和其他污染物进入内部,从而保护电机的内部组件,延长其使用寿命。 环洋市场咨询机构出版的调研分析报告【全球封闭式电机行业总体规模、主要厂商及IPO上市调研报告,2025-2031】研究全球封闭式电机总体规
    GIRtina 2025-01-06 11:10 104浏览
  • 在智能家居领域中,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.  硅电容是什么首先我们需要了解电容是什么?物理学上电容的概念指的是给定电位差下自由电荷的储藏量,记为C,单位是F,指的是容纳电荷的能力,C=εS/d=ε0εrS/4πkd(真空)=Q/U。百度百科上电容器的概念指的是两个相互靠近的导体,中间夹一层不导电的绝缘介质。通过观察电容本身的定义公式中可以看到,在各个变量中比较能够改变的就是εr,S和d,也就是介质的介电常数,金属板有效相对面积以及距离。当前
    知白 2025-01-06 12:04 173浏览
  • PLC组态方式主要有三种,每种都有其独特的特点和适用场景。下面来简单说说: 1. 硬件组态   定义:硬件组态指的是选择适合的PLC型号、I/O模块、通信模块等硬件组件,并按照实际需求进行连接和配置。    灵活性:这种方式允许用户根据项目需求自由搭配硬件组件,具有较高的灵活性。    成本:可能需要额外的硬件购买成本,适用于对系统性能和扩展性有较高要求的场合。 2. 软件组态   定义:软件组态主要是通过PLC
    丙丁先生 2025-01-06 09:23 85浏览
  • 彼得·德鲁克被誉为“现代管理学之父”,他的管理思想影响了无数企业和管理者。然而,关于他的书籍分类,一种流行的说法令人感到困惑:德鲁克一生写了39本书,其中15本是关于管理的,而其中“专门写工商企业或为企业管理者写的”只有两本——《为成果而管理》和《创新与企业家精神》。这样的表述广为流传,但深入探讨后却发现并不完全准确。让我们一起重新审视这一说法,解析其中的矛盾与根源,进而重新认识德鲁克的管理思想及其著作的真正价值。从《创新与企业家精神》看德鲁克的视角《创新与企业家精神》通常被认为是一本专为企业管
    优思学院 2025-01-06 12:03 119浏览
我要评论
0
点击右上角,分享到朋友圈 我知道啦
请使用浏览器分享功能 我知道啦