软件能力提升记录---技术文档

最新推荐文章于 2021-02-26 19:25:21 发布

拳拳小布

最新推荐文章于 2021-02-26 19:25:21 发布

阅读量375

点赞数 1

CC 4.0 BY-SA版权

分类专栏： C语言|代码质量文章标签： vscode ide visual studio code

本文链接：https://blog.csdn.net/quanquanxiaobu/article/details/110621308

为什么要写这篇

工作之余的时间不多，任何一点儿小的能力提升都可以被记录下来。

从真正意识到自己已经成为一名嵌入式软件工程师后的一个多月，一直在致力于提升自己的软件能力，C语言掌握能力，代码规范，注释规范，markdown工程说明，功能流程图。用尽一切自己可以接触到的方法。书籍，微信公众号，博客倒是没怎么看，也努力做着记录，虽然没有都写成博客，但之后肯定会进行补充。

这五者之间的联系是从微观到宏观，对于函数的实现方式依赖于C语言掌握能力，代码规范使得程序可读性可复用性提高，注释规范不只是函数的注释，还包含功能模块的文件头注释，功能流程图是功能的实现流程，markdown文档是工程的文档。

说起技术文档，应该追溯到我写的RGB灯的功能模块，模块里面因为函数调用关系分为外部调用和内部调用，为了将内部实现逻辑描述清楚需要函数调用关系，曾经在文件头注释中作过努力，在函数注释上作过努力，还曾经写文档记录：关于函数调用关系，关于蓝牙报文协议(发送端与接收端的字节含义约定)，关于报文举例。虽然写得一团浆糊，但应该坚持，就像画漫画一样，一开始自己画得完全与美不沾边，但坚持下去，会越来越好的。此处忍不住附图一幅，见笑。

代码规范

先提下和代码规范有点儿关系的代码格式化吧，就是一些空格、缩进之类的，影响代码阅读，本来该是一种程序员编程习惯，但代码已经那样了，总要想办法弥补一下，有个软件叫Astyle。官网下载：Astyle 下载据我实际使用，可以在Keil上配置，也可以在VScode中配置。

说下有多渴望自己写的代码规范吧。让我印象很深刻的是项目工程，两个全局变量，多个源文件调用，还是很重要的数据，导致花了挺长时间才理出头绪来，这让我想到了之前编写的不堪回首的计算器代码，也正是知道自己曾经写的代码多么不堪，才知道自己提升代码规范有多么重要。

首先是致力于代码可读性和写明显无bug的代码，然后是将程序可复用性提高。我觉得这篇比较好：【程序员必读】经验：编程的智慧，标题什么的就别吐槽了。同时还有了解了一下RT-Thread的代码规范和uCOS的代码规范。收获三言两语说不明白，也可能因为两个操作系统的代码规范定义并未让我有所收获，就像功夫见人家演练一遍