为什么你的Code,很难看?

原创 玩转单片机与嵌入式 2023-11-10 07:00

点击下方名片,关注公众号,获取更多精彩内容

欢迎关注【玩转单片机与嵌入式】公众号,回复关键字获取更多免费视频和资料

回复【加群】,单片机】、【STM32】、【硬件知识】、【硬件设计】、【经典电路】、【论文】、【毕业设计】、【3D封装库】、PCB】、电容】、TVS】、阻抗匹配】、【资料】、【终端电阻】、【Keil】、【485】、【CAN】、【振荡器】、[USBCAN]、【PCB】、【智能手环】、【智能家居】、【智能小车】、【555】、【I2C】、【华为】、【中兴】,等……


前段时间共享了常用单词的缩写cfg】" linktype="text" imgurl="" imgdata="null" data-itemshowtype="0" tab="innerlink" style="letter-spacing: 0.034em; font-size: 15px;" data-linktype="2">【总结了近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()。一般嵌入式编程需要加前缀,这个前缀一般是所在模块名字。
在本公众号内回复【英语单词】可以获取小编整理的近800个单词的常用缩写。

END

扫描上方二维码加群,回复【加群】或扫码加我好友,限时免费进入技术交流群。


推荐阅读



【专辑】器件选型


【专辑】单片机


【专辑】经验分享


【专辑】STM32


【专辑】硬件设计


【专辑】软件设计


【专辑】开源项目


【专辑】职业发展

感谢大家阅读,如果喜欢

请点赞和“在看”吧,或者分享到朋友圈。

点击跳转到原文,限时优惠加入我们的知识星球(加好友获取免费券)

玩转单片机与嵌入式 专注单片机、嵌入式、学习资料、最新设计、案例等。以单片机为起点,带你玩转单片机、嵌入式。
评论
  • 高速先生成员--黄刚这不马上就要过年了嘛,高速先生就不打算给大家上难度了,整一篇简单但很实用的文章给大伙瞧瞧好了。相信这个标题一出来,尤其对于PCB设计工程师来说,心就立马凉了半截。他们辛辛苦苦进行PCB的过孔设计,高速先生居然说设计多大的过孔他们不关心!另外估计这时候就跳出很多“挑刺”的粉丝了哈,因为翻看很多以往的文章,高速先生都表达了过孔孔径对高速性能的影响是很大的哦!咋滴,今天居然说孔径不关心了?别,别急哈,听高速先生在这篇文章中娓娓道来。首先还是要对各位设计工程师的设计表示肯定,毕竟像我
    一博科技 2025-01-21 16:17 101浏览
  • 2024年是很平淡的一年,能保住饭碗就是万幸了,公司业绩不好,跳槽又不敢跳,还有一个原因就是老板对我们这些员工还是很好的,碍于人情也不能在公司困难时去雪上加霜。在工作其间遇到的大问题没有,小问题还是有不少,这里就举一两个来说一下。第一个就是,先看下下面的这个封装,你能猜出它的引脚间距是多少吗?这种排线座比较常规的是0.6mm间距(即排线是0.3mm间距)的,而这个规格也是我们用得最多的,所以我们按惯性思维来看的话,就会认为这个座子就是0.6mm间距的,这样往往就不会去细看规格书了,所以这次的运气
    wuliangu 2025-01-21 00:15 186浏览
  • Ubuntu20.04默认情况下为root账号自动登录,本文介绍如何取消root账号自动登录,改为通过输入账号密码登录,使用触觉智能EVB3568鸿蒙开发板演示,搭载瑞芯微RK3568,四核A55处理器,主频2.0Ghz,1T算力NPU;支持OpenHarmony5.0及Linux、Android等操作系统,接口丰富,开发评估快人一步!添加新账号1、使用adduser命令来添加新用户,用户名以industio为例,系统会提示设置密码以及其他信息,您可以根据需要填写或跳过,命令如下:root@id
    Industio_触觉智能 2025-01-17 14:14 122浏览
  •  光伏及击穿,都可视之为 复合的逆过程,但是,复合、光伏与击穿,不单是进程的方向相反,偏置状态也不一样,复合的工况,是正偏,光伏是零偏,击穿与漂移则是反偏,光伏的能源是外来的,而击穿消耗的是结区自身和电源的能量,漂移的载流子是 客席载流子,须借外延层才能引入,客席载流子 不受反偏PN结的空乏区阻碍,能漂不能漂,只取决于反偏PN结是否处于外延层的「射程」范围,而穿通的成因,则是因耗尽层的过度扩张,致使跟 端子、外延层或其他空乏区 碰触,当耗尽层融通,耐压 (反向阻断能力) 即告彻底丧失,
    MrCU204 2025-01-17 11:30 182浏览
  •     IPC-2581是基于ODB++标准、结合PCB行业特点而指定的PCB加工文件规范。    IPC-2581旨在替代CAM350格式,成为PCB加工行业的新的工业规范。    有一些免费软件,可以查看(不可修改)IPC-2581数据文件。这些软件典型用途是工艺校核。    1. Vu2581        出品:Downstream     
    电子知识打边炉 2025-01-22 11:12 53浏览
  •  万万没想到!科幻电影中的人形机器人,正在一步步走进我们人类的日常生活中来了。1月17日,乐聚将第100台全尺寸人形机器人交付北汽越野车,再次吹响了人形机器人疯狂进厂打工的号角。无独有尔,银河通用机器人作为一家成立不到两年时间的创业公司,在短短一年多时间内推出革命性的第一代产品Galbot G1,这是一款轮式、双臂、身体可折叠的人形机器人,得到了美团战投、经纬创投、IDG资本等众多投资方的认可。作为一家成立仅仅只有两年多时间的企业,智元机器人也把机器人从梦想带进了现实。2024年8月1
    刘旷 2025-01-21 11:15 399浏览
  • 数字隔离芯片是一种实现电气隔离功能的集成电路,在工业自动化、汽车电子、光伏储能与电力通信等领域的电气系统中发挥着至关重要的作用。其不仅可令高、低压系统之间相互独立,提高低压系统的抗干扰能力,同时还可确保高、低压系统之间的安全交互,使系统稳定工作,并避免操作者遭受来自高压系统的电击伤害。典型数字隔离芯片的简化原理图值得一提的是,数字隔离芯片历经多年发展,其应用范围已十分广泛,凡涉及到在高、低压系统之间进行信号传输的场景中基本都需要应用到此种芯片。那么,电气工程师在进行电路设计时到底该如何评估选择一
    华普微HOPERF 2025-01-20 16:50 73浏览
  • 临近春节,各方社交及应酬也变得多起来了,甚至一月份就排满了各式约见。有的是关系好的专业朋友的周末“恳谈会”,基本是关于2025年经济预判的话题,以及如何稳定工作等话题;但更多的预约是来自几个客户老板及副总裁们的见面,他们为今年的经济预判与企业发展焦虑而来。在聊天过程中,我发现今年的聊天有个很有意思的“点”,挺多人尤其关心我到底是怎么成长成现在的多领域风格的,还能掌握一些经济趋势的分析能力,到底学过哪些专业、在企业管过哪些具体事情?单单就这个一个月内,我就重复了数次“为什么”,再辅以我上次写的:《
    牛言喵语 2025-01-22 17:10 41浏览
  • 现在为止,我们已经完成了Purple Pi OH主板的串口调试和部分配件的连接,接下来,让我们趁热打铁,完成剩余配件的连接!注:配件连接前请断开主板所有供电,避免敏感电路损坏!1.1 耳机接口主板有一路OTMP 标准四节耳机座J6,具备进行音频输出及录音功能,接入耳机后声音将优先从耳机输出,如下图所示:1.21.2 相机接口MIPI CSI 接口如上图所示,支持OV5648 和OV8858 摄像头模组。接入摄像头模组后,使用系统相机软件打开相机拍照和录像,如下图所示:1.3 以太网接口主板有一路
    Industio_触觉智能 2025-01-20 11:04 150浏览
  • 本文介绍瑞芯微开发板/主板Android配置APK默认开启性能模式方法,开启性能模式后,APK的CPU使用优先级会有所提高。触觉智能RK3562开发板演示,搭载4核A53处理器,主频高达2.0GHz;内置独立1Tops算力NPU,可应用于物联网网关、平板电脑、智能家居、教育电子、工业显示与控制等行业。源码修改修改源码根目录下文件device/rockchip/rk3562/package_performance.xml并添加以下内容,注意"+"号为添加内容,"com.tencent.mm"为AP
    Industio_触觉智能 2025-01-17 14:09 164浏览
  • 嘿,咱来聊聊RISC-V MCU技术哈。 这RISC-V MCU技术呢,简单来说就是基于一个叫RISC-V的指令集架构做出的微控制器技术。RISC-V这个啊,2010年的时候,是加州大学伯克利分校的研究团队弄出来的,目的就是想搞个新的、开放的指令集架构,能跟上现代计算的需要。到了2015年,专门成立了个RISC-V基金会,让这个架构更标准,也更好地推广开了。这几年啊,这个RISC-V的生态系统发展得可快了,好多公司和机构都加入了RISC-V International,还推出了不少RISC-V
    丙丁先生 2025-01-21 12:10 112浏览
我要评论
0
点击右上角,分享到朋友圈 我知道啦
请使用浏览器分享功能 我知道啦