代码质量提升的点滴---小成篇

目录

这段时间做了什么

达到了什么程度

为什么要这么做

我想要的结果是什么


这段时间做了什么

用我自己的表述来说就是认真去对待自己的代码。何为根?何为基础?同时记录下条条框框,当顾此失彼时可以回来查看查看,自我反省。

达到了什么程度

每个源文件头都有注释,每个函数都有注释,函数代码块内几乎没有注释。每个函数逻辑清晰到自己几秒内就回忆起实现了什么功能,源文件内按照功能划分区域,头文件中函数声明注明哪个源文件调用,自己定义的变量位置和作用清晰(修改基本不会出现无用变量遗留),模块文件移植方便(将底层函数调用提供接口文件分开,修改时只需修改该源文件即可,上层逻辑不用更改),工程有markdown文档。功能有移植说明,有流程图。功能实现有伪代码理清逻辑(正在做)。之后就可以将注意力更多地放在功能实现和前期方案考虑上,或者学习新知识并总结上。

为什么要这么做

量变引起质变,量变是指功能过程实现,质变是对功能总体,乃至上升到设计及用户体验上。

这是一个很花费时间的体力活。这段时间写的代码不算多但也说不上少,但是归根结底也就是一直维护几个文件,然后修修改改,同时对产品要实现的功能有一些新的认识,添加进去,源文件移植(为了节省成本芯片换了一次又一次),自己对于要做什么实现什么需求不可控,但起码可以对代码可控吧。

做是为了不做。不被自己给绊倒。也是为了给自己一个好的开头,开始时不注重习惯,后面想形成习惯就难了。不以事小而轻视它。基础的事是简单的事,并不代表不重要,对于代码工程来说,架构是基础的事,但是重要的事,比如接口文件,将具体实现逻辑与底层函数非直接接触,程序移植就非常方便,不容易出错。

我想要的结果是什么

要功能实现,而非具体代码逻辑,该怎么做?接触一些面向对象的思想。

不惜一切用尽方法提升软件编程能力,如今自己对于写得代码看了又看,改了又改。有一个多月的时间了,从实现功能开始,到看公众号文章提升C语言掌控能力,使用新方式实现功能,再到开始对代码添加注释,后来又偶尔看到一篇文章了解了有一种注释风格可以生成技术文档,再尽可能将之前的注释改成这种风格,再加上一些其他技术文档的编写,其中还学会了markdown文档。再到博客中贴出小的函数,到代码段,再到今天对自己写过的几个工程进行整理维护。知识点较少,花费的工夫完全可以用来学更多东西,但是我并没有,因为我坚信这么做是对的。对于自己的代码认真负责,同时也为了一步一个脚印,之后写出比这更好的代码。同时这也是一个程序员的代码风格。

猜你喜欢

转载自blog.csdn.net/quanquanxiaobu/article/details/111601061