C编程规范

  1 /*******************************************************************************

  2  Copyright (c) 2013,  All rights reserved.

  3 --------------------------------------------------------------------------------

  4                             work_section_name.c

  5   Project Code: 

  6    Module Name: 

  7   Date Created: 2014-07-17

  8         Author:

  9    Description: 

 10 

 11 --------------------------------------------------------------------------------

 12   Modification History

 13   DATE        NAME             DESCRIPTION

 14 --------------------------------------------------------------------------------

 15   YYYY-MM-DD

 16 

 17 *******************************************************************************/

 18 /* 引用 */

 19 #ifndefine GRAPHICS_H

 20 #define    GRAPHICS_H

 21 

 22 /* 引用标准库的头文件 */

 23 #include <stdio.h> 

 24 #include <math.h> 

 25 

 26 /* 引用非标准库的头文件 */

 27 #include "myheader1.h"

 28 #include "myheader2.h"

 29 

 30 /* 全局函数声明 */

 31 void Function1(XXXX);

 32 void Function2(XXXX);

 33 

 34 /* 全局变量 */

 35 void *g_pVar;

 36 

 37 /* 结构体声明 */

 38 typedef struct tagC_FuckOrder

 39 {

 40     /* 四个空格取代Tab */

 41     xxxx

 42 }C_ORDER_S;

 43 

 44 typedef union tagC_FuckOrder

 45 {

 46     /* 四个空格取代Tab */

 47     xxxx

 48 }C_ORDER_U;

 49 

 50 

 51 #endif

 52 

 53 /*****************************************************************************

 54     Func Name: 

 55  Date Created: 

 56        Author: 

 57   Description: 

 58         Input: IN INT iData,        需要封装的INT类型的数据

 59        Output: OUT VOID *pEncData   封装的TLV结构

 60        Return: INT 数据的长度

 61       Caution: 

 62 ------------------------------------------------------------------------------

 63   Modification History

 64   DATE        NAME             DESCRIPTION

 65   --------------------------------------------------------------------------

 66   YYYY-MM-DD

 67 

 68 *****************************************************************************/

 69 /* 模块间函数 */

 70 void WORK_SECTIONNAME_FunctionName(IN IF_DIAG_PARA_S *psVar, 

 71                                    IN char *strSource

 72                                    OUT long strDestintion)

 73 {

 74     /* 注意命名习惯 */

 75     int iVar;

 76     UINT uiVar;

 77     long LVar;

 78     ULONG ulVar;

 79     char acVar[6];

 80     char szVar[6];

 81 

 82     /* 注意空格 */

 83     while (i=0; i<10; i++)

 84     {

 85         ULONG ulVar;

 86         int *piVar = &uiVar;

 87         

 88         /* LONG */

 89         if ((ulVar>=-0.1) && (ulVar<=0.1))

 90         {

 91             statement;

 92         }

 93         else

 94         {

 95             statement;

 96         }

 97         

 98         /* BOOL */

 99         if (flag)

100         {

101             XXXX;

102         }

103         

104         /* POINT */

105         if (NULL == piVar)

106         {

107             XXXX;

108         }

109         

110         statement;

111     }

112     /* Step 1: 做什么什么 */

113     statement;

114     

115     /* Step 2: 做什么什么 */

116     statement;

117     

118     /* Step 3: 做什么什么 */

119     statement;

120     

121     return;

122 }

123 

124 /* 模块内函数 */

125 void work_sectionname_FunctionName(IN IF_DIAG_PARA_S *psVar, 

126                                    OUT const long LVar)

127 {

128     XXXX;

129 }