养成良好的编程习惯

  • 芯片去字笔
  • LV2工程师
  • |      2016-01-05 14:56:30
  • 浏览量 557
  • 回复:2

程序设计风格指一个人编制程序时所表现出来的特点,习惯逻辑思路等。 在程序设计中要使程序结构合理、清晰,形成良好的编程习惯对程序的要求不仅是可以在机器上执行,给出正确的结果,而且要便于程序的调试和维护,这就要求编写的程序不仅自己看得懂,而且也要让别人能看懂。


模块化的程序结构

模块化程序设计即模块化设计,简单地说就是程序的编写不是开始就逐条录入计算机语句和指令,而是首先用主程序、子程序、子过程等框架把软件的主要结构和流程描述出来,并定义和调试好各个框架之间的输入、输出链接关系。逐步求精的结果是得到一系列以功能块为单位的算法描述。以功能块为单位进行程序设计,实现其求解算法的方法称为模块化。模块化的目的是为了降低程序复杂度,使程序设计、调试和维护等操作简单化。


举个简单的应用实例:设计一款单片机控制器,该控制器接收串口发送来的文字信息,显示在128X64的单色液晶屏上。通过约定的协议方式来确定文字的字体、大小、文字内容在什么位置、以什么样的方式来显示。根 据模块化的程序设计思想,程序代码分布在四个模块内:串口数据收发模块、数据协议解析处理模块、LCD文字显示处理模块、主程序模块。如此一来,每个模块 都完成了目的明确、功能单一的程序代码,每个模块再通过头文件,将模块中的接口函数、全局变量、结构体等内容导出。主程序模块按照主流程图引用模块功能, 最终实现系统功能。

清晰易懂的命名规则

名字,这个词汇在我们的工作生活当中扮演者不可或缺的角色。名字是对物体进行的一种信息标注,没有名称的标识,想一想我们还能做什么工作?当我们对事物命名的时候,也不是随心所欲的命名的,一座山、一条河、一辆车、一本书、一条街道、一辆货车、一个零件、一个人等等。对于事物,往往通过名字,我们就能够大概的清楚与它相关的一系列信息。同理,在编写程序的时候,我们也不能随随便便的给程序当中的函数、变量、常量、宏等元素随意的命名!随意命名,就会使程序的易读性大大降低,程序的易维护性也大大降低,这样,可能或一定会使程序的运行稳定性、效率、维护效果大打折扣。这样的程序很可能的一个结果就是半途而废。

一个公司、一个团队,必须要有自己的命名规则,而这个命名规则,可以借鉴当前非常成功、使用非常广泛的命名规则,比如:驼 峰命名法。驼峰命名法,分为小驼峰命名与大驼峰命名。驼峰命名法就是当变量名或函式名是由一个或多个单词连结在一起,而构成的唯一识别字时,第一个单词以 小写字母开始;第二个单词的首字母大写(小驼峰命名,比如:myFirstName)或每一个单词的首字母都采用大写字母(大驼峰命名,比如:MyFirstName)。有了命名规则的约定,通过名字,我们可以清晰的知道变量存数数据的含义,清晰的了解函数的功能与作用,同时程序的可维护性得到很大的提升。


简洁明了的注释方法

程序的注释是必不可少的,恰当的注释可以将程序模块的前世今生描述的非常清晰,比如:公司名称、版权、作者名称、时间、模块用途、背景介绍等,复杂的算法需要加上流程说明;恰当的注释可以将函数的功能作用描述的非常具体,函数注释包括:输入、输出、函数描述、流程处理、全局变量、调用样例等,复杂的函数需要加上变量用途说明;恰当的注释还可以把重要的变量作用与用途标注清晰,甚至还将它的使用说明加以表述。


模块注释

/***************************************

*模块功能:

*公司版权:

*创建人:

*联系方式:

*日期:

*修改人:

*日期:

*模块说明:

*版本:

*****************************************/

函数注释

/****************************************

*函数名称:

*函数功能:
*入口参数:

*返回值:

*全局变量:

*调用方式:

*作者:

*日期:
*版本:

*****************************************/

程序代码或变量注释:

//程序代码或变量定义行尾使用“//”注释,

//多行注释换行,也使用“//”,这样在读

//程序过程中,能够清楚得知其对应注释为

//程序内容注释。标注内容为代码含义,变

//量使用方法,取值范围,代表含义等等。


清晰易读的文本格式

无规矩不成方圆,通过程序代码书写的格式就可以大概了解你的程序质量(也可以看出你是不是喜欢整洁的人:>)!程序代码并不是你随意堆砌在,必须要格式工整。程序书写时,必须要有缩进,而且每一条语句必须要换行。通过恰当的所以可以很清晰的读懂代码的嵌套关系。程序是最复杂的东西(虽然你开始写的程序很简单,但它们会逐渐变得复杂起来),是需要用智力去把握的智力产品。良好的格式能使程序结构一目了然,帮助你和别人理解它,帮助你的思维,也帮助你发现程序中不正常的地方,使程序中的错误更容易被发现。

养成良好的编程习惯,是从事嵌入式系统开发的每个从业者必须要具备的基本素质。好的编程习惯,会让你的程序开发过程变得非常享受,会让你的程序事半功倍,会... ..
  • 0
  • 收藏
  • 举报
  • 分享
我来回复

登录后可评论,请 登录注册

所有回答 数量:2
hlwhlw 2016-01-11
不错,顶一个。
0   回复
举报
发布
冰山一角 2016-01-07
不错啊   可以借鉴
0   回复
举报
发布
x
收藏成功!点击 我的收藏 查看收藏的全部帖子