现在单片机的程序设计,C51已经得到广泛的推广和应用,算是单片机的主流设计程序,甚至可以说作为单片机开发人员必须要掌握的一门语言了。
作为一门工具,最终的目的就是实现功能。在满足这个前提条件下,我们希望我们的程序能很容易地被别人读懂,或者能够很容易地读懂别人的程序,在团体合作开发中就能起到事半功倍之效。在网上请求帮助时,如能以规范的写法贴出程序,网友会比较容易地明白你的问题,则会比较快的得到网友的帮助,否则让人看上半天也不明所以然,这样就达不到预期的效果了。因此,为了便于源程序的交流,减少合作开发中的障碍,希望大家能够探讨一下C51的编程规范。把各人认为好的建议提出来,然后做一个总结,作为一种大家一致认同的规范,我认为将会是一件很有意义的事。我先提出一些自已的想法,以此抛砖引玉。
一、注释
1,采用中文; 2,开始的注释:
文件(模块)注释内容: 公司名称、版权、作者名称、修改时间、模块功能、背景介绍等,复杂的算法需要加上流程说明;
比如: /*********************************************************************/ /*公司名称: */
/*模 块 名: LCD 模块 LCD 型号:HD44780 */
/*创 建 人:zhaojunjie 日期:2001-06-08 */ /*修 改 人: 日期:2001-06-08 */ /*功能描述: */ /*其他说明: */ /*版 本: /**********************************************************************/
函数开头的注释内容: 函数名称、功能、说明 输入、返回、函数描述、流程处理、全局变量、调用样例等,复杂的函数需要加上变量用途说明;
/********************************************************************* * * 函 数 名: v_LcdInit * 功能描述: LCD初始化 * 函数说明: 初始化命令:0x3c, 0x08, 0x01, 0x06, 0x10, 0x0c * 调用函数: v_Delaymsec(),v_LcdCmd() * 全局变量: * 输 入: 无 * 返 回: 无 * 设 计 者:zhao 日期:2001-12-09 * 修 改 者:zhao 日期:2001-12-09 * 版 本: ***********************************************************************/
3、程序中的注释内容:
修改时间和作者、方便理解的注释等。注释内容应简炼、清楚、明了,一目了然的语句不加注释。 |