怎么写出好代码?

嵌入式资讯精选 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携手北航出版社共办人工智能师资培训

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


嵌入式资讯精选 掌握最鲜资讯,尽领行业新风
评论
  • 全球知名半导体制造商ROHM Co., Ltd.(以下简称“罗姆”)宣布与Taiwan Semiconductor Manufacturing Company Limited(以下简称“台积公司”)就车载氮化镓功率器件的开发和量产事宜建立战略合作伙伴关系。通过该合作关系,双方将致力于将罗姆的氮化镓器件开发技术与台积公司业界先进的GaN-on-Silicon工艺技术优势结合起来,满足市场对高耐压和高频特性优异的功率元器件日益增长的需求。氮化镓功率器件目前主要被用于AC适配器和服务器电源等消费电子和
    电子资讯报 2024-12-10 17:09 84浏览
  • 时源芯微——RE超标整机定位与解决详细流程一、 初步测量与问题确认使用专业的电磁辐射测量设备,对整机的辐射发射进行精确测量。确认是否存在RE超标问题,并记录超标频段和幅度。二、电缆检查与处理若存在信号电缆:步骤一:拔掉所有信号电缆,仅保留电源线,再次测量整机的辐射发射。若测量合格:判定问题出在信号电缆上,可能是电缆的共模电流导致。逐一连接信号电缆,每次连接后测量,定位具体哪根电缆或接口导致超标。对问题电缆进行处理,如加共模扼流圈、滤波器,或优化电缆布局和屏蔽。重新连接所有电缆,再次测量
    时源芯微 2024-12-11 17:11 68浏览
  • 习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习笔记&记录学习习笔记&记学习学习笔记&记录学习学习笔记&记录学习习笔记&记录学习学习笔记&记录学习学习笔记记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记录学习学习笔记&记
    youyeye 2024-12-10 16:13 105浏览
  • 【萤火工场CEM5826-M11测评】OLED显示雷达数据本文结合之前关于串口打印雷达监测数据的研究,进一步扩展至 OLED 屏幕显示。该项目整体分为两部分: 一、框架显示; 二、数据采集与填充显示。为了减小 MCU 负担,采用 局部刷新 的方案。1. 显示框架所需库函数 Wire.h 、Adafruit_GFX.h 、Adafruit_SSD1306.h . 代码#include #include #include #include "logo_128x64.h"#include "logo_
    无垠的广袤 2024-12-10 14:03 69浏览
  • 智能汽车可替换LED前照灯控制运行的原理涉及多个方面,包括自适应前照灯系统(AFS)的工作原理、传感器的应用、步进电机的控制以及模糊控制策略等。当下时代的智能汽车灯光控制系统通过车载网关控制单元集中控制,表现特殊点的有特斯拉,仅通过前车身控制器,整个系统就包括了灯光旋转开关、车灯变光开关、左LED前照灯总成、右LED前照灯总成、转向柱电子控制单元、CAN数据总线接口、组合仪表控制单元、车载网关控制单元等器件。变光开关、转向开关和辅助操作系统一般连为一体,开关之间通过内部线束和转向柱装置连接为多,
    lauguo2013 2024-12-10 15:53 78浏览
  • 近日,搭载紫光展锐W517芯片平台的INMO GO2由影目科技正式推出。作为全球首款专为商务场景设计的智能翻译眼镜,INMO GO2 以“快、准、稳”三大核心优势,突破传统翻译产品局限,为全球商务人士带来高效、自然、稳定的跨语言交流体验。 INMO GO2内置的W517芯片,是紫光展锐4G旗舰级智能穿戴平台,采用四核处理器,具有高性能、低功耗的优势,内置超微高集成技术,采用先进工艺,计算能力相比同档位竞品提升4倍,强大的性能提供更加多样化的应用场景。【视频见P盘链接】 依托“
    紫光展锐 2024-12-11 11:50 44浏览
  • 概述 通过前面的研究学习,已经可以在CycloneVGX器件中成功实现完整的TDC(或者说完整的TDL,即延时线),测试结果也比较满足,解决了超大BIN尺寸以及大量0尺寸BIN的问题,但是还是存在一些之前系列器件还未遇到的问题,这些问题将在本文中进行详细描述介绍。 在五代Cyclone器件内部系统时钟受限的情况下,意味着大量逻辑资源将被浪费在于实现较大长度的TDL上面。是否可以找到方法可以对此前TDL的长度进行优化呢?本文还将探讨这个问题。TDC前段BIN颗粒堵塞问题分析 将延时链在逻辑中实现后
    coyoo 2024-12-10 13:28 101浏览
  • 天问Block和Mixly是两个不同的编程工具,分别在单片机开发和教育编程领域有各自的应用。以下是对它们的详细比较: 基本定义 天问Block:天问Block是一个基于区块链技术的数字身份验证和数据交换平台。它的目标是为用户提供一个安全、去中心化、可信任的数字身份验证和数据交换解决方案。 Mixly:Mixly是一款由北京师范大学教育学部创客教育实验室开发的图形化编程软件,旨在为初学者提供一个易于学习和使用的Arduino编程环境。 主要功能 天问Block:支持STC全系列8位单片机,32位
    丙丁先生 2024-12-11 13:15 45浏览
  • 一、SAE J1939协议概述SAE J1939协议是由美国汽车工程师协会(SAE,Society of Automotive Engineers)定义的一种用于重型车辆和工业设备中的通信协议,主要应用于车辆和设备之间的实时数据交换。J1939基于CAN(Controller Area Network)总线技术,使用29bit的扩展标识符和扩展数据帧,CAN通信速率为250Kbps,用于车载电子控制单元(ECU)之间的通信和控制。小北同学在之前也对J1939协议做过扫盲科普【科普系列】SAE J
    北汇信息 2024-12-11 15:45 70浏览
  • RK3506 是瑞芯微推出的MPU产品,芯片制程为22nm,定位于轻量级、低成本解决方案。该MPU具有低功耗、外设接口丰富、实时性高的特点,适合用多种工商业场景。本文将基于RK3506的设计特点,为大家分析其应用场景。RK3506核心板主要分为三个型号,各型号间的区别如下图:​图 1  RK3506核心板处理器型号场景1:显示HMIRK3506核心板显示接口支持RGB、MIPI、QSPI输出,且支持2D图形加速,轻松运行QT、LVGL等GUI,最快3S内开
    万象奥科 2024-12-11 15:42 65浏览
  • 我的一台很多年前人家不要了的九十年代SONY台式组合音响,接手时只有CD功能不行了,因为不需要,也就没修,只使用收音机、磁带机和外接信号功能就够了。最近五年在外地,就断电闲置,没使用了。今年9月回到家里,就一个劲儿地忙着收拾家当,忙了一个多月,太多事啦!修了电气,清理了闲置不用了的电器和电子,就是一个劲儿地扔扔扔!几十年的“工匠式”收留收藏,只能断舍离,拆解不过来的了。一天,忽然感觉室内有股臭味,用鼻子的嗅觉功能朝着臭味重的方向寻找,觉得应该就是这台组合音响?怎么会呢?这无机物的东西不会腐臭吧?
    自做自受 2024-12-10 16:34 136浏览
我要评论
0
点击右上角,分享到朋友圈 我知道啦
请使用浏览器分享功能 我知道啦