怎么写出好代码?

嵌入式资讯精选 2022-05-02 10:48

简单一句话说就是:不要太早下手写。


1.画图纸

编程就像盖房子,盖房子第一步是设计,画出蓝图。


对应到编程就是写设计文档,首先概要设计,画清楚流程图,程序分层架构图,每一层包含的模块。


模块的划分,每个模块功能、对外接口,模块内部子模块的划分,每个子模块功能,以及接口,都要写清楚。


最近从我司的某个模块代码学到了,复杂的业务涉及到流程,数据,事件很多。


此时一个子模块处理事件,利用了自己实现的事件发布订阅中心;

一个子模块处理收到的数据;

一个子模块实现发数据;

一个子模块进行每个步骤超时处理,利用了自己实现的一个timer模块。

一个中心模块负责事件分发及整体流程启动和停止。

简直清晰得不得了,太赞了。


2.搭架子

有了概要设计差不多可以开始编码了(其实还有详细设计)。


编码的第一步是搭架子,写好主要的接口,定义好主要用到timer、任务、队列等,将主流程串起来,切忌陷入细节。


以上面的例子来说。

事件处理模块,先定义出整个业务流程需要处理的事件;定义出事件处理回调函数,回调函数先空在那里,不要急着去实现。

定义一个队列,用来放所有收到的事件。

定义事件发布回调函数,用于当事件产生时事件中心调起该回调通知本模块事件产生了;

定义初始化函数,初始化要做的是调用事件中心模块接口去注册事件,注册事件发布回调函数,初始化函数可以先实现。


收数据模块,向数据收发驱动层注册收到数据的回调,回调先不去实现。


 发数据模块,定义好发数据接口。


timer模块,定义需要用到的timer,定义好timer超时回调函数,回调先不实现,然后在timer初始化函数中调用timer模块添加timer。


在中心模块定义一个启动流程接口,去调用各个子模块初始化函数,创建任务,任务里面轮询事件模块是否有新事件到,有的话调用事件分发接口进行事件分发(即从队列中取出事件并调用事件处理的回调函数)。


就这样整个架子搭起来了,我理解有点像盖房子先搭好楼四个角那几根承重的柱子以及每层的横梁和楼板。


3.填空

然后再把刚刚空出来的那些回调以及接口都填上具体实现代码。


然而写的中间还是会发现有些地方没想清楚,没设计好,比如刚刚定义的事件少了,发现还需定一个事件,那就加上;又比如接口少了或是接口参数不合理。这种情况是不可避免的。


昨天领导和我说,好的设计是能够让人照着这个设计写出代码,如果看着文档不知道该咋写说明设计得还是不够好。先记一下。


4.最后说一下

如果仅仅盯着代码其实远远不够,整个系统包含编译部分、厂商SDK、OS适配层、SDK适配层、我司平台层(包括各种公共模块和组件)、应用层。


编译部分,包含编译工具GCC、编译批处理工具make,编译脚本makefile(现在又有了CMake,自动生成Makefile,貌似现在都用这个了)、代码编译框架。


代码编译框架根据用户输入的编译指令选择去找到配置文件,根据配置文件编译应用层哪个产品应用代码,编译平台层哪些公共模块,驱动层去链接哪个厂商的SDK,以及哪个版本的SDK等等。


编译前还会根据配置文件生成一些C头文件,里面是一些配置信息,诸如产品型号、软件版本等等,还有自动生成部分代码、编译后自动生成接口说明文档等功能。


而代码其实是表层的东西,如果不了解背后原理直接看代码就会很痛苦,比如如果不了解MQTT的通信机制,直接去啃代码, 看到写着订阅主题都不知道在干嘛。


编码能力是一方面,另一方面是学习各种技术的原理,能够用起来。


后续一 一拆解学习。


最后推荐一个挺好玩的网站:tree.fm,里面收集了世界各地森林里的声音(一般是鸟叫虫鸣,溪流等等的声音),以及实拍的图片,有时候工作时或者睡前打开听听这种白噪音感觉特别治愈。图片还能保存,界面如下:


祝大家假期愉快!


1.SylixOS,这款嵌入式RTOS值得学习!

2.芯片短缺或将结束?数据来说话。。。

3.代码调着调着就失联了,你碰到过吗?

4.图文并茂详解STM32时钟配置

5.电力物联网与嵌入式系统,关系几何?

6.RT-Thread携手北航出版社共办人工智能师资培训

免责声明:本文系网络转载,版权归原作者所有。如涉及作品版权问题,请与我们联系,我们将根据您提供的版权证明材料确认版权并支付稿酬或者删除内容。


嵌入式资讯精选 掌握最鲜资讯,尽领行业新风
评论 (0)
  • 二位半 5线数码管的驱动方法这个2位半的7段数码管只用5个管脚驱动。如果用常规的7段+共阳/阴则需要用10个管脚。如果把每个段看成独立的灯。5个管脚来点亮,任选其中一个作为COM端时,另外4条线可以单独各控制一个灯。所以实际上最多能驱动5*4 = 20个段。但是这里会有一个小问题。如果想点亮B1,可以让第3条线(P3)置高,P4 置低,其它阳极连P3的灯对应阴极P2 P1都应置高,此时会发现C1也会点亮。实际操作时,可以把COM端线P3设置为PP输出,其它线为OD输出。就可以单独控制了。实际的驱
    southcreek 2025-05-07 15:06 691浏览
  • 随着智能驾驶时代到来,汽车正转变为移动计算平台。车载AI技术对存储器提出新挑战:既要高性能,又需低功耗和车规级可靠性。贞光科技代理的紫光国芯车规级LPDDR4存储器,以其卓越性能成为国产芯片产业链中的关键一环,为智能汽车提供坚实的"记忆力"支持。作为官方授权代理商,贞光科技通过专业技术团队和完善供应链,让这款国产存储器更好地服务国内汽车厂商。本文将探讨车载AI算力需求现状及贞光科技如何通过紫光国芯LPDDR4产品满足市场需求。 车载AI算力需求激增的背景与挑战智能驾驶推动算力需求爆发式
    贞光科技 2025-05-07 16:54 243浏览
  • 后摄像头是长这个样子,如下图。5孔(D-,D+,5V,12V,GND),说的是连接线的个数,如下图。4LED,+12V驱动4颗LED灯珠,给摄像头补光用的,如下图。打开后盖,发现里面有透明白胶(防水)和白色硬胶(固定),用合适的工具,清理其中的胶状物。BOT层,AN3860,Panasonic Semiconductor (松下电器)制造的,Cylinder Motor Driver IC for Video Camera,如下图。TOP层,感光芯片和广角聚焦镜头组合,如下图。感光芯片,看着是玻
    liweicheng 2025-05-07 23:55 581浏览
  • 温度传感器的工作原理依据其类型可分为以下几种主要形式:一、热电阻温度传感器利用金属或半导体材料的电阻值随温度变化的特性实现测温:l ‌金属热电阻‌(如铂电阻 Pt100、Pt1000):高温下电阻值呈线性增长,稳定性高,适用于工业精密测温。l ‌热敏电阻‌(NTC/PTC):NTC 热敏电阻阻值随温度升高而下降,PTC 则相反;灵敏度高但线性范围较窄,常用于电子设备温控。二、热电偶传感器基于‌塞贝克效应‌(Seebeck effect):两种不同
    锦正茂科技 2025-05-09 13:31 319浏览
  • Matter协议是一个由Amazon Alexa、Apple HomeKit、Google Home和Samsung SmartThings等全球科技巨头与CSA联盟共同制定的开放性标准,它就像一份“共生契约”,能让原本相互独立的家居生态在应用层上握手共存,同时它并非另起炉灶,而是以IP(互联网协议)为基础框架,将不同通信协议下的家居设备统一到同一套“语义规则”之下。作为应用层上的互通标准,Matter协议正在重新定义智能家居行业的运行逻辑,它不仅能向下屏蔽家居设备制造商的生态和系统,让设备、平
    华普微HOPERF 2025-05-08 11:40 465浏览
  • 文/郭楚妤编辑/cc孙聪颖‍相较于一众措辞谨慎、毫无掌舵者个人风格的上市公司财报,利亚德的财报显得尤为另类。利亚德光电集团成立于1995年,是一家以LED显示、液晶显示产品设计、生产、销售及服务为主业的高新技术企业。自2016年年报起,无论业绩优劣,董事长李军每年都会在财报末尾附上一首七言打油诗,抒发其对公司当年业绩的感悟。从“三年翻番顺大势”“智能显示我第一”“披荆斩棘幸从容”等词句中,不难窥见李军的雄心壮志。2012年,利亚德(300296.SZ)在深交所创业板上市。成立以来,该公司在细分领
    华尔街科技眼 2025-05-07 19:25 520浏览
  • 硅二极管温度传感器是一种基于硅半导体材料特性的测温装置,其核心原理是利用硅二极管的电学参数(如正向压降或电阻)随温度变化的特性实现温度检测。以下是其工作原理、技术特点及典型应用:一、工作原理1、‌PN结温度特性‌硅二极管由PN结构成,当温度变化时,其正向电压 VF与温度呈线性负相关关系。例如,温度每升高1℃,VF约下降2 mV。2、‌电压—温度关系‌通过jing确测量正向电压的微小变化,可推算出环境温度值。部分型号(如SI410)在宽温域内(如1.4 K至475 K)仍能保持高线性度。
    锦正茂科技 2025-05-09 13:52 342浏览
  • 飞凌嵌入式作为龙芯合作伙伴,隆重推出FET-2K0300i-S全国产自主可控工业级核心板!FET-2K0300i-S核心板基于龙芯2K0300i工业级处理器开发设计,集成1个64位LA264处理器,主频1GHz,提供高效的计算能力;支持硬件ECC;2K0300i还具备丰富的连接接口USB、SDIO、UART、SPI、CAN-FD、Ethernet、ADC等一应俱全,龙芯2K0300i支持四路CAN-FD接口,具备良好的可靠性、实时性和灵活性,可满足用户多路CAN需求。除性价比超高的国产处理器外,
    飞凌嵌入式 2025-05-07 11:54 118浏览
  • 在印度与巴基斯坦的军事对峙情境下,歼10C的出色表现如同一颗投入平静湖面的巨石,激起层层涟漪,深刻印证了“质量大于数量”这一铁律。军事领域,技术优势就是决定胜负的关键钥匙。歼10C凭借先进的航电系统、强大的武器挂载能力以及卓越的机动性能,在战场上大放异彩。它能够精准捕捉目标,迅速发动攻击,以一敌多却毫不逊色。与之形成鲜明对比的是,单纯依靠数量堆砌的军事力量,在面对先进技术装备时,往往显得力不从心。这一现象绝非局限于军事范畴,在当今社会的各个领域,“质量大于数量”都已成为不可逆转的趋势。在科技行业
    curton 2025-05-11 19:09 66浏览
  • UNISOC Miracle Gaming奇迹手游引擎亮点:• 高帧稳帧:支持《王者荣耀》等主流手游90帧高画质模式,连续丢帧率最高降低85%;• 丝滑操控:游戏冷启动速度提升50%,《和平精英》开镜开枪操作延迟降低80%;• 极速网络:专属游戏网络引擎,使《王者荣耀》平均延迟降低80%;• 智感语音:与腾讯GVoice联合,弱网环境仍能保持清晰通话;• 超高画质:游戏画质增强、超级HDR画质、游戏超分技术,优化游戏视效。全球手游市场规模日益壮大,游戏玩家对极致体验的追求愈发苛刻。紫光展锐全新U
    紫光展锐 2025-05-07 17:07 414浏览
我要评论
0
0
点击右上角,分享到朋友圈 我知道啦
请使用浏览器分享功能 我知道啦