编程规范——养成良好的个人编程习惯

命名

• 函数 MyExcitingFunction() 每个单词首字母大写
• 类、结构体、枚举 class CUrlTable 每个单词首字母大写
• 变量
  • int iMaxCount = 1; //n表示
  • intfloat fDegree = 1.0f; //f表示浮点,小数点后需要加f
  • double dDegree = 1.0; //d表示double
  • bool bFlag = true; //b表示bool
  • const char *pFileName = argv[0]; //p表示指针类型
  • bool g_bEnableMipmapFeature; //全局变量使用g_,名称尽量长
  • int m_nGreen; //类成员变量使用m_
  • static int s_nCount; //静态变量使用s_
  • byte *m_pImageData; //类成员指针m_p
  • enum FilterType{ kFilterTypeBase, ;//枚举kEnumName or E_EnumName};
  • typedef struct ExportDataBlob
    {
    /// Size of the data in bytes
    size_t size; //结构体成员变量不需要加m_
    /// The data. //结构体成员首字母不需要大写
    void* data; }ExportDataBlob; 类型小写+作用大写

注释

.h文件的注释和.h文件下函数的注释（cpp文件和函数不注释）

   ///-------------------------------------------------------------------------------------------------
    /// @brief AR渲染基类（文件名称:描述）
    /// @author caicaptain （作者）
    /// @date 2017/7/2 （时间）
    /// @note          （注意）
    /// @version 1.0.0 （版本）
    ///-------------------------------------------------------------------------------------------------

    ///-------------------------------------------------------------------------------------------------
    /// @brief	Transform landmark by exif.
    ///
    /// @author	caicaprain
    /// @date	2017/7/2
    ///
    /// @param [in]	nExifOpt		The exif option.
    /// @param [out]	nLength			The length.
    ///
    /// @return	True if it succeeds, false if it fails.
    ///-------------------------------------------------------------------------------------------------
	bool Test(int nExifOpt, std::string &nLength);

命名空间

///-------------------------------------------------------------------------------------------------
/// @brief 命名空间的简单概述 \n(换行)
/// 命名空间的详细概述
///-------------------------------------------------------------------------------------------------
namespace OST
 {
 }

类、结构、枚举标注

///-------------------------------------------------------------------------------------------------
/// @brief 类的简单概述 \n(换行)
/// 类的详细概述
///-------------------------------------------------------------------------------------------------
class Example
 {
 };
 
枚举类型定义、结构体类型定义注释风格类似
 ///-------------------------------------------------------------------------------------------------
/// @brief 简要说明文字 
///-------------------------------------------------------------------------------------------------

typedef struct 结构体名字
 {
      成员1, //!简要说明文字
      成员2, //!简要说明文字
      成员3, //!简要说明文字
 }结构体别名;