编码规范-如何定义一个优美的类变量

来源:互联网 发布:javascript取数组分割 编辑:程序博客网 时间:2024/05/16 04:57

7.变量
变量包括:全局变量、静态类变量、对象变量、参数变量、临时变量等。
① 变量尽可能延后定义。
② 变量定时时赋予默认值或错误值。
③ 变量能“望名知意”。
④ 注意变量的生命周期和作用域。
⑤ 变量一名一意,不要重名。

7.1.变量定义
③ 格式为:变量类型 变量名称; //变量注释
④ 5个变量一组;
⑤ 变量名称的首字母为列25;
⑥ 变量注释的首字母为列51;

样例:

int             m_i32TaskID;            //任务idstring              m_strTaskCode;          //任务编号int             m_i32OrderID;           //工单idstring              m_strOrderCode;         //工单编号int             m_i32ProcessID;         //工序idstring              m_strProcessCode;       //工序编号int             m_i32MaterialID;        //物料idstring              m_strMaterialCode;      //物料编号unsigned int                m_ui32RetryCount;       //重试次数//区分一个任务被数据终端多次申请部分加工数unsigned int                m_ui32BeginSeq;         //该工单的开始序号unsigned int            m_ui32EndSeq;           //该工单的结束序号unsigned int            m_ui32CurSeq;           //该工单的当前序号int             m_i32LabelID;           //条码标签idint             m_i32RuleID;            //条码规则id

7.2.变量命名
① 格式为:[作用域类型_]变量类型前缀变量名称[ = 默认值]。
② 全局变量为:g_i32DevCount;静态类变量为:sm_i32DevCount;对象变量为:m_i32DevCount;参数变量、临时变量为i32DevCount;
③ 采用大小写混合,不使用下划线。多个单词或单词缩写之间靠大写字母来区分。如:m_i32DevCount。
④ 一般采用形容词+名称组合。
⑤ 布尔型变量一般为:bIs变量名称。如:m_bIsRT208。
⑥ 变量名称长度最好能控制在20个字母之内,可以适当考虑英文缩写。
⑦ 相关模块、相似功能的变量命名规则一致。
⑧ 优先采用行业内、公司内、部门内的业务术语。
⑨ 尽可能采用英文,避免采用拼音及拼音缩写。
⑩ 命名中不要使用a/b/c 1/2/3类似的序号来区分不同的变量。

0 0
原创粉丝点击