命名规范

数据库命名规范

命名要素	命名要求	示例
表名	TB_+名称	TB_Order
视图	VIEW_+名称	VIEW_Order
过程	PROC_+名称	PROC_InputOrder
函数	FUN_+名称	FUN_InputOrder
索引	IX_+表名+_字段名	IX_Order_ID
触发器	TG_+表名+_触发事件类型	TG_Order_Add

 

注释规范：

1.  注释尽量用中文；

2.  注释的内容要清楚、明了，含义准确，防止注释二义性；

3.  自定义源文件和自定义函数的开始部分要有综合性注释；

4.  全局变量、自定义常量要有其功能注释；

5.  不易理解或易误理解的代码要有注释；

6.  分支不能表达含义，要有注释；

7. 保证注释与代码的一致性。过期的注释要删除；

注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。变量注释和变量在同一行，所有注释必须对齐，与变量分开至少两个Tab键。程序段或语句的注释在程序段或语句的上一行

事例：

///文件名称:example.cpp                
///主要功能：示例说明             
///公司名称：PYC                    
///版本修改历史                    ----可选项
///XXXX-XX-XX   某某 创建        ----可选项
///XXXX-XX-XX   某某 修改        ----可选项

#include “xxxxxx.h”

#define    USERID_LEN             5        //企业标识长度
#define    PROTECT_TYPE_LEN     400        //保护类型长度

char        _strUserId[USERID_LEN]                     = “”;        //企业标识    
char        _strProtectTypes[PROTECT_TYPE_LEN]     = “”;        //企业保护类型    

/// <summary>
/// 方法描述
/// </summary>
/// <param name="strConnName">参数说明</param>
/// <returns>返回值描述</returns>

void getUserInfoData()
{
    int iRows = 0;
    int iCols = 0;
    int i = 0;
    ………………………………………

    //复杂算法要有功能注释 ，或者单独函数
    ……………………………
    ……………………………
    ……………………………
    //功能结束

    //如果分支条件不能表达含义，要有注释
if (XXXX)
    {
        ………………
    }
    for(i = 0; i <= iRows; i++)
    {
        ……………………………
        //功能注释
        //modified  | add by 某某某 XXXX-XX-XX          ----可选项
        ……………………………
        // modified | add end
    }
}