注释规范

文件注释，函数注释等，参考doxygen规模。

注释规范

  1. 每个C文件开头都一段注释，标明文件的名称，作者，编写日期，文件描述与版本修改，下面是一个可以参考的例子：
/*=====================================================
*   Copyright (C) 2014 All rights reserved.
*   
*   Filename：calculate.c
*   Author：luqiang
*   Date：2015/01/12
*   Description：this is the description.
*
======================================================*/
  1. 每个函数的定义处都需要写注释，表示该函数的名称，作者，作用，以及该函数的输入输出值。
  2. 程序的关键代码需要用注释说明
  3. 注意注释不要过多，很多时候，可以通过合理的命名让程序具有*自解释性*。