分析一套源代码的代码规范和风格并讨论如何改进优化代码

  我的工程实践名称是“风扇调度”,主要由C语言编写,由于部分代码不能公开,因此我就以我用到的一个工具进行分析。这个工具实现的是C语言实现配置文件的读取。项目地址是:https://github.com/xiethon/read_configfile

  首先来看这套代码的目录结构:

分析一套源代码的代码规范和风格并讨论如何改进优化代码_第1张图片

 

 

  麻雀虽小,五脏俱全。将不同类型的文件分别存放在不同的文件夹下面,然后将项目根据每个函数的功能不同进行拆分,拆分成不同的文件,适合后续的开发工作。并且拥有README.md文件,对项目进行合理的解释。接下来观察debug.h文件:

分析一套源代码的代码规范和风格并讨论如何改进优化代码_第2张图片

 

  图中可以看到,虽然这应该是一个简单的功能实现,但是作者并没有把它当作简单的任务来处理,细节非常到位,对这种宏进行了定义,各种细节事无巨细的注意到了,以防止程序运行时出现不应该出现的错误。这种注意细节的工程,常见于各种优秀的源代码,他们的代码通常会有各种各样保护,才想到各种各样的可能性,尽量提高程序的鲁棒性。这一点值得我们学习。接下来继续查看readconfig.c:

分析一套源代码的代码规范和风格并讨论如何改进优化代码_第3张图片

 

 

  这里面同样有非常多值得分析和学习的好习惯。第一,在每个函数前给与适当的说明。这在程序开发的过程中非常的重要,这可以方便别人和自己阅读程序,有时可以通过只阅读函数解释就可以了解函数的作用和原理,大大提高效率,同时对返回值和输入值进行了明确的规定,方便其他人的使用。第二,规范的命名。规范的命名可以让别人更好的理解程序,有利于程序的开发和改进,既要说明变量的意义,又可以实现变量作用,这就是好的命名方法。第三,细节的处理。还是程序鲁棒性的话题,我们可以看到作者在这上面用了很多心思,确保在各种情况下程序可以正确的运行。

 

   总而言之,通过阅读和理解优秀的源代码可以让我们进步,尽力去理解作者的意图,对于我们提高技术水平非常重要。

 

你可能感兴趣的:(分析一套源代码的代码规范和风格并讨论如何改进优化代码)