博客首页 | 排行榜 |

PSOCPSOC的博客

个人档案
博文分类
注释的写法  2010-07-26 17:45

今天突然看以前的程序觉得稍微有点吃力了,都怪当初没有注释,郁闷,特此查了注释的写法,基本写法如下:/*******************************************************************
1602A初始化函数
//函数原型:void LCM_Init(void)
//函数功能:1602A初始化
//输入参数:无
//输出参数:无
//调用模块:
//建立时间:2005/11/14
//作者:站长
 //版本:V1.0
//修改时间:无
//修改人:
//应用描述:
*********************************************************************/

下面是来自网上的一段话觉得很好贴在这里:

程序会随着功能复杂度的提升变得越来越大,文件个数越来越多,层次也越来越细,函数数量更是与日俱增,如果没有一个好的注释风格和注释习惯,恐怕若干天后自己写的程序也很难再看懂了,最重要的是往往今天写的程序日后却总会用到,复制粘贴是个不错的办法,然而突然发现不知道该复制什么粘贴到哪,那真是令人十分恼火,所以奉劝所有的初学者千万不要轻视注释,甚至不屑去写,怕麻烦或是图一时之快,要知道现在花几分钟把难懂的程序注释一下,那可以一劳永逸的事情哦!下面介绍几种注释的方法:

对于每个文件都要有注释,说明该文件的作用,层次,类别,版权,作者,日期等,格式如下:
这种注释也叫做文件注释
 

 

类别:默认 |
上一篇:逻辑分析仪分析程序 | 下一篇:24C04一次读写最多8个字节
以下网友评论只代表其个人观点,不代表本网站的观点或立场