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

原创 2018年04月16日 11:18:26

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

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语言编程规范(个人规约)

0规范制定说明 0.1箴言 技术人员设计程序的首要目的是用于技术人员沟通和交流,其次才是用于控制CPU的。程序的生命力在于用户使用,程序的成长在于后期的维护及根据用户需求更新和升级功能。如果你的程序只...
  • zhanglianpin
  • zhanglianpin
  • 2015-06-18 09:51:38
  • 5960

嵌入式软件c编程规范

  • 2012年07月21日 17:56
  • 1.48MB
  • 下载

嵌入式C语言编程规范--函数(个人规约)

函数设计的精髓:整洁,同时把代码有效组织起来。整洁要求:代码简单直接、不隐藏设计者的意图、用干净利落的抽象和直截了当的控制语句将功能实现。代码的有效组织包括:逻辑层组织和物理层组织两个方面。逻辑层,主...
  • qq_39815416
  • qq_39815416
  • 2018-04-16 16:48:05
  • 16

(一)阿里巴巴JAVA编程规范之编程规约

(一) 命名规约 1. 【强制】所有编程相关命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。 反例: _name / __name / $Object / name_ / name...
  • qq_19701185
  • qq_19701185
  • 2017-02-13 21:20:18
  • 2301

华为C语言编程规范--变量、结构

5-1:去掉没必要的公共变量。 说明:公共变量是增大模块间耦合的原因之一,故应减少没必要的公共变量以降低模块间的耦合度。 5-2:仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的...
  • softn
  • softn
  • 2016-06-16 17:38:44
  • 434

Linux下的C语言编码规范

1    缩进为4个字符     指针类型声明如 char *p;引用声明如 int &b = a; 2    函数或者类定义后要加空行;函数内或者类内逻辑上不相关的语句要加空行 3    函数或...
  • u010292827
  • u010292827
  • 2015-06-29 00:59:55
  • 1031

【R语言】【规范】编程规范

Google发布R语言格式规范内部指导 原创                                                2016-09-06             ...
  • tobeyourlover
  • tobeyourlover
  • 2016-09-20 10:48:58
  • 1295

嵌入式C语言编程规范--变量、常量、宏(个人规约)

一. 变量1. 一个变量只有一个功能,不能把一个变量用作多种用途说明:一个变量只用来表示一个特定功能,不能把一个变量作多种用途,即同一变量取值不同时,其代表的意义也不同。示例:具有两种功能的反例   ...
  • qq_39815416
  • qq_39815416
  • 2018-04-16 15:48:39
  • 2

嵌入式C语言编程规范--排版与格式(个人规约)

1、相对独立的程序块之间、变量说明之后必须加空行;if (!valid_ni(ni)) { // program code ... } //空行 repssn_ind = ssn_...
  • qq_39815416
  • qq_39815416
  • 2018-04-16 18:25:20
  • 11

嵌入式C语言编程规范--常见的通用缩写(个人规约)

嵌入式C语言编程规范中,常见的通用缩写如下所示:
  • qq_39815416
  • qq_39815416
  • 2018-04-16 10:27:17
  • 2
收藏助手
不良信息举报
您举报文章:嵌入式C语言编程规范--命名规则(个人规约)
举报原因:
原因补充:

(最多只允许输入30个字)