風之逍遥的博客

学习笔记,请大牛指点江山

嵌入式C语言编程规范--命名规则(个人规约)

通用命名规则:标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解

1. 移植代码和修改部分代码时,保持原命名风格;

2. 目录名、文件名、函数文件名、函数参数名、变量名等, 如果无特殊的需求 (如果是引用其他地方, 可以保留相应的名称 ),均采用UNIX风格 :“ 全小写 + 下划线 ”(特别注明除外)。

    说明:不同系统对文件名大小写处理( MS 的 DOS 、Windows不区分大小写,但是 Linux 系统则区分),所以代码文件命名建议一采用全小写字母。

3. 禁止使用单字节命名变量,但允许定义i、j、k作为局部循环变量;

4. 除了常见的通用缩写以外,不使用单词缩写,不得使用汉语拼音;

常见的通用缩见链接:https://blog.csdn.net/qq_39815416/article/details/79957239

5. 用正确的反义词组命名具有乎此意义的变量或相反动作的函数;见下图:


6. 尽量避免名字中出现数字编号,除非逻辑上的确需要编号;

7. 标识符前不应添加模块、项目、产品、部门的名称作为前缀。

一、变量名:

1. 全局变量和全局静态变量添加前缀;全局变量十分危险,能不用则不用,不得不用时,通过前缀使得全局变量更加醒目,警醒使用时格外小心;单个文件内部使用全局变量,应加static关键字进行封装,变成全局静态变量。

示例:int g_number = 0; //全局变量         static int s_number = 0;//全局静态变量

全局变量应增加“g_”前缀,静态变量应增加“s_”前缀;

应使用名词或者形容词+名词方式命名变量

2. 一个变量只有一个功能,不能把一个变量用作多种用途。

二、变量类型:

1. 基本变量类型用typedef按以下形式定义(移植或修改的文件,保持原风格):

    typedef signed           char         int_8;

    typedef signed   short int          int_16;

    typedef signed    long int          int_32;

    typedef usigned          char        uint_8;

    typedef usigned  short int         uint_16;

    typedef usigned   long int          uint_32;

2. 非基本变量类型,如结构体、指针、枚举、共同体不得使用typedef形式定义(移植或修改的文件,保持原风格),规范的使用方法如下示例。说明:使用typedef会隐藏这个变量实际是什么类型,在传递参数时,会增加出错概率。

示例:

        结构体声明与定义:                                                                枚举类型声明与定义:

        struct TIME                                                                                enum WEEK

          {                                                                                                {

                int data;                                                                                    MONDAY = 1,TUESDAY = 2;

                int day;                                                                                  }  ; 

            };                                                                                            enum WEEK week;

            struct TIME time;     

结构功能单一;不要设计面面俱到的数据结构。

结构型的数组、多维的数组如果在定义时初始化,按照数组的矩阵结构分行书写。

intaiNumbers[4][3]=

{

1,1,1,

2,4,8,

3,9,27,

4,16,64

}

三、宏、枚举成员采用:全大写 + 下划线   形式 ,单词之间加下划线„_‟的方式命名;

    1. 除了头文件或编译开关等特殊标识定义,宏定义不能使用下划线开头和结尾。

四、函数命名应以函数要执行的动作命名,一般采用动词或者动词+名词的结构;                                                 

                


阅读更多
版权声明:本文为博主原创文章,博主允许 可以转载。 https://blog.csdn.net/qq_39815416/article/details/79956961
文章标签: 命名规则
上一篇读《华为C语言编程规范》——头文件笔记
下一篇嵌入式C语言编程规范--常见的通用缩写(个人规约)
想对作者说点什么? 我来说一句

没有更多推荐了,返回首页

关闭
关闭