编程规范学习(1)：注释和命名

　　既然准备好好的弄，就先把编程规范给学习下，先看华为的规范，从简单的文件注释和命名开始，这2块是最容易搞乱的，还是得坚持住，天天看，每次编程看一次，就不信还搞不定，下面摘下大概的规范内容，有部分修改了点。

　　注释规范：文件注释

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

　　Copyright:     

　　File name:     文件名

　　Description:   用于详细说明此程序文件完成的主要功能

　　Author:       作者

　　Version:       版本  

　　Date:         完成日期

　　History:       修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。    

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

　　函数注释：

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

    Function:              //  函数名称

    Description:        //  函数功能、性能等的描述

    Called By:            //  调用本函数的函数清单

    Input:                    //  输入参数说明，包括每个参数的作

                                    //  用、取值说明及参数间关系。

    Output:                  //  对输出参数的说明。

    Return:                  //  函数返回值的说明

    Others:                  //  其它说明

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

　　短注释用“\\”,超过3行的注释用“/*   */”来注释，注释内容要写到被注释内容的上面或者旁边。

      对于宏定义、数据结构声明要做明确的说明，数据结构要对结构内容的每一条做明确说明。

      对于全局变量，最好做到在一个函数里进行赋值和修改，并做好说明：变量的作用，取值范围，以及哪些函数使用

 

      对于文件命名：虽然有很多种方法，不过方法太多就让我不知道用哪种，所以用着用着就全部混乱了。还是选择个合适的来规定自己，这样就不怕混乱了。

      函数命名：首字母大写的方式,例：WriteDate();

      宏定义和数据类型：用全部大写，例#define MAX 10

      变量命名：用全部小写加下划线的方式，全局变量前面带g_(global)，函数里的静态变量用s_(static)，文件内部的全局变量则用l_(local) ，常量命名则用c_(const)，还有数据类型，可以用u8,u16,u32,s8,s16,s32等表示，例：一个u8的全局变量，可以表示为gu8_,感觉有点怪，这个还是再考虑考虑

 

　　其他的后面再看，先把这部分坚持住了，大概也就差不多了。