软件工程之命名规则（C）

为规范个人的C语言软件开发，同时也便于团队内的代码交流共享，现暂定一种写码风格。

如有建议，欢迎拍砖。

宏：全部大写，单词间用下划线隔开，不同作用的宏格式使用不同格式；

         普通的编译控制宏：如头文件中限制编译时只一次包含的宏 : 

                        #ifndef _IMSGE_H_

                       #define _IMSGE_H_

                        //.....

                        #endif

         功能配置宏：

                       //#define __DEBUG_USE_JTAG
                        #define __DEBUG_USE_UART

         常量宏：

                        #define OSC_8M              1

                        #define OSC_72M           2

                        #define SYSTEM_OSCOSC_72M

结构体：

         类型名：每个单词的首字母均大写；如（类似于Java C#等Class名）

                   typedefstruct

                  {        

                            U8 status;

                  }TaskPhotoInfo;

        

        成员名：

                  变量及结构体变量均这个变量首字母小写，其余每个单词首字母大写；如

                 typedef struct

                {

                       U8 status;

                       struct

                       {

                          U8 enable;

                       }ctrl;

               }MsgNoticeInfo;

             

枚举：

            类型名：每个单词的首字母均大写；如

              enum MsgNoticeType

             {

                      MSG_TYPE_TFCARD_IS_FULL,

                     MSG_TYPE_POWER_IS_LOW,

                      MSG_TYPE_SIMCARD_NO_MONEY,

                      MSG_TYPE_USER_SET_OK

            }

          成员名：所有字母均大写，单词见用下划线隔开；（原因：常量值均用大写表示，与常量宏一致）

 

变量：该变量首字母小写，其余每个单词首字母大写；如

                 U8    isPhotoEanble;

 

typedef 类型名：每个单词的首字母均大写；如typedef unsigned char  U8 ,  typedef  signed int S16；

 

函数：函数名首字母小写，其余每个单词的首字母均大写；如

                     void sendMsgNotice(void)

                   {

                          //…

                   }

     

文件名：每个单词的首字母均大写，.c与.h文件一一对应，如

                 SendData.c SendData.h

 

 如有异议，欢迎拍砖！