为了增加程序的可读性,方便合作者读动程序,或者程序作者在一段时间之后还能看懂程序,我们需要在程序中写 注释。
在比较特殊的函数使用或者命令调用的地方加单行注释。使用方法为:
Tbuf_putchar(c,RTbuf); // 将数据加入到发送缓冲区并开中断
extern void Delay1s(uint16 n); // n <= 6 ,when n==7, it is 1. 在模块化的函数中使用详细段落注释:
/***********************
** 函数名称: Com_putchar
** 功能描述: 从串行口输出一个字符c
** 输 入: c:输出字符
** 输出 : 0:失败 1:成功
** 全局变量: 无
** 调用模块:
** 说明:
** 注意:
********************/在文件头上加文件名,文件用途,作者,日期等信息。
/*********************************************************************************************************
** serial driver
** (c) Copyright 2005-2006, limaokui
** All Rights Reserved
**
** V1.1.0
**
**
**--------------文件信息--------------------------------------------------------------------------------
**文 件 名:sio.c
**创 建 人: 李茂奎
**最后修改日期: 2005年7月13日
**描 述: serial driver
**
**--------------历史版本信息----------------------------------------------------------------------------
** 创建人: 李茂奎
** 版 本: V1.00
** 日 期: 2005年7月13日
** 描 述: 原始版本
**
*********************************************************************************************************/要清楚,注释是为了方便阅读,增强程序的可度性,不要本末倒置,不要给很简单大家都能看明白的程序加注释,不要让注释淹没了你的程序结构。对于函数,变量等尽量使用文件名自注释的方法,及通过文件名就可以知道意思。
本文结束了,新手教程也结束了,希望我们教程能让你轻松进入AVR的世界。
上一篇:AVR看门狗使用范例