1 / 24
文档名称:

C++编码规范.doc

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

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

分享

预览

C++编码规范.doc

上传人:相惜 2021/10/22 文件大小:87 KB

下载得到文件列表

C++编码规范.doc

相关文档

文档介绍

文档介绍:编辑版word
页脚下载后可删除,如有侵权请告知删除!
编辑版word
1.    命名规那么
. 起个适宜的名字
.    类的名称〔适用于C++〕
²  类的名称要能告诉我们,这个类是什么。因此,类的名称通常是名词。
²  类的名字不需要告诉我们,它从哪个类继承而来的。
²  有时候加个后缀是很有用的。比方类是一个代理(Agents)时,起名叫DownloadAgent更能表达真实的意图。
.    方法和函数的名称〔适用于C/C++〕
²  方法和函数通常都要执行某种行为,因此,名称要能清楚的说明它做什么:CheckForErrors() 而不是ErrorCheck(),DumpDataToFile() 而不是 DataFile()。 这样也可以很容易的区别函数和数据。
²  函数名总以动词开头,后面跟随其它名称。这样看起来更自然些。
²  可以加一些必要的后缀:
Max – 表示取最大值
Cnt – 表示当前的计数值
Key – 表示键值
例如:RetryMax 表示可接收的最大数,RetryCnt表示当前接收的数量。
²  前缀也同样有用:
Is – 用于询问一些问题。只要看到Is开头,就知道这是一个查询。
Get – 用于获取一个值。
Set – 用于设置一个值。
例如:IsHitRetryLimit.
.   含有度量单位的名称〔适用于C/C++〕
²  如果一个变量用于表示时间,重量或其它度量单位,应把度量单位添加到名称中,以便开发人员更早一步发现问题。
例如:
uint32 mTimeoutMsecs;
uint32 mMyWeightLbs;
.    缩写名称不要全部大写〔适用于C/C++〕
²  无论是什么缩写名称,我们总以一个大写字母开头,后面跟随的字母全部用小写。
例如:
class FluidOz;            // 而不是 FluidOZ
编辑版word
页脚下载后可删除,如有侵权请告知删除!
编辑版word
class NetworkAbcKey;      // 而不是 NetworkABCKey
〔适用于C++〕
²  用大写字母作为单词的分隔,每个单词的首字母大写,其它字母均小写。
²  名字的第一个字母应大写
²  不含有下划线 ('_')
例如:
   class NameOneTwo; 
   class Name;
〔或程序库〕命名 〔适用于C/C++〕
²  使用命名空间防止名字冲突。
²  如果编译器没有实现命名空间,需要用前缀来避名名字冲突,不过前缀不要过长〔2个字母比拟好〕。
例如:
John Johnson 完成了一个数据构造的库,它可以使用JJ作为库的前缀,所以类名就象下面这样:
   class JjLinkList
   {
   }
〔适用于C++〕
²  使用与类名一样的规那么
例如:
   class NameOneTwo
   {
   public:
      int     DoIt();
      void    HandleError();
   }
〔适用于C++〕
²  属性〔通常是非公有数据成员〕名字以字母'm'开头。
²  在 'm(m_)'  后面,使用与类名一样的规那么。
²  'm(m_)' 总是位于其它修饰符〔如表示指针的 'p'〕的前面。
例如:
   class NameOneTwo
编辑版word
页脚下载后可删除,如有侵权请告知删除!
编辑版word
   {
   public:
      int     VarAbc();
      int     ErrorNumber();
   private:
      int          mVarAbc;
      int          mErrorNumber;
      String*      mpName;
   }
〔适用于C++〕
²  第一个字母必须小写。
²  第一个字母后面的单词使用与类名一样的规那么。
例如:
   class NameOneTwo
   {
   public:
      int     StartYourEngines(
                               Engine&rSomeEngine,
                              E