1 / 24
文档名称:

C++编码规范.docx

格式:docx   大小:32KB   页数:24页
下载后只包含 1 个 DOCX 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

C++编码规范.docx

上传人:wz_198613 2022/7/21 文件大小:32 KB

下载得到文件列表

C++编码规范.docx

相关文档

文档介绍

文档介绍:1.    命名规则
. 起个合适的名字
.    类的名称(适用于C++)
²  类的名称要能告诉我们,这个类是什么。因此,类的名称通常是名词。
²  类的名字不需要告诉我们,它从哪个类继承而来的。
²  有时候or(int errorNumber)
   {
      int            error= OsErr();
      Time           time_of_error;
     ErrorProcessor error_processor;
   }
(适用于C/C++)
²  指针变量多数情况应在前面加 'p'。
²  星号 '*' 应靠近类型,而不是变量名。
例如:
  String* pName=new String;
 
  特别的:String* pName, name; 应分成两行来写:
  String* pName;
  String  name;
(适用于C++)
²  引用必须用 'r'作前缀修饰。
例如:
   class Test
   {
   public:
      void               DoSomething(StatusInfo&rStatus);
 
     StatusInfo&        rStatus();
      constStatusInfo&  Status() const; // 这里返回的是常量引用,所以不符合本规则
 
   private:
     StatusInfo&        mrStatus;
   }
.   全局变量的命名前缀(适用于C/C++)
²  全局变量总是以 'g(g_)' 作为前缀。
例如:
    Logger g_Log;
    Logger* g_pLog;
.   全局常量的命名(适用于C/C++)
²  全局常量全部大写,并以下划线 '_' 分隔单词。
例如:
    const intA_GLOBAL_CONSTANT = 5;
.   静态变量的命名前缀(适用于C++)
²  静态变量以 's' 作为前缀。
例如:
   class Test
   {
   public:
   private:
      staticStatusInfo m_sStatus;
   }
.   自定义类型(typedef)的命名(适用于C/C++)
²  类型定义名称指的是用typedef定义的名称。
²  类型定义名称使用与类名相同的规则,并使用Type作为后缀。
例如:
   typedefuint16  ModuleType;
   typedefuint32  SystemType;
.   宏定义的命名(适用于C/C++)
²  所有单词的字母都用大写,并使用下划线 '_' 分隔.
例如:
#define MAX(a,b) blah
#define IS_ERR(err) blah
.   C 函数的命名(适用于C/C++)
²  C++项目中,应尽量少用C函数。
²  C函数使用GNU规范,所有字母都使用小写,并用下划线 '_' 作为单词的分隔。
例如:
   int
  some_bloody_function()
   {
   }
²  特别的,为了赚容C/C++,在必要的时候,在C++中应以下面的格式定义C函数:
   extern “C” int some_bloody_function();
²  或在C/C++中推荐使用下面的格式:
   #ifdef__cplusplus__
   extern “C”{
   #endif
   int
  some_bloody_function()
   {
   }
   #ifdef__cplusplus__
   }
   #endif
.   枚举的命名(适用于C/C++)
²  所有字母都大写,并用下划线 '_' 作为单词分隔。
例如:
   enumPinStateType
   {
      PIN_OFF,
      PIN_ON
   };
enum { STATE_ERR, STATE_OPEN, STATE_RUNNING, STATE_DYING};
2.    排版规则
. 布局和模板
.    类的布局模板 (适用于C++)
²  请使