51Halcon机器视觉

 找回密码
 会员注册

QQ登录

只需一步,快速开始

扫一扫,微信登录

查看: 2421|回复: 2

[资料] C++命名规则

[复制链接]
  • TA的每日心情
    点赞
    1 小时前
  • 签到天数: 955 天

    连续签到: 1 天

    [LV.10]以坛为家III

    379

    主题

    1551

    帖子

    7280

    积分

    Rank: 9

    积分
    7280

    突出贡献优秀版主荣誉管理论坛元老切换助手验证会员最佳新人

    发表于 2016-8-31 10:12:43 | 显示全部楼层 |阅读模式

    51Halcon诚邀您的加入,专注于机器视觉开发与应用技术,我们一直都在努力!

    您需要 登录 才可以下载或查看,没有帐号?会员注册

    x
    如果想要有效的管理一个稍微复杂一点的体系,针对其中事物的一套统一、带层次结构、清晰明了的命名准则就是必不可少而且非常好用的工具。
    活跃在生物学、化学、军队、监狱、黑社会、恐怖组织等各个领域内的大量有识先辈们都曾经无数次地以实际行动证明了以上公理的正确性。除了上帝(设它可以改变世间万物的秩序)以外,相信没人有实力对它不屑一顾。
    在软件开发这一高度抽象而且十分复杂的活动中,命名规则的重要性更显得尤为突出。一套定义良好并且完整的、在整个项目中统一使用的命名规范将大大提升源代码的可读性和软件的可维护性。
    在引入细节之前,先说明一下命名规范的整体原则:
    同一性
    在编写一个子模块或派生类的时候,要遵循其基类或整体模块的命名风格,保持命名风格在整个模块中的同一性。
    标识符组成
    标识符采用英文单词或其组合,应当直观且可以拼读,可望文知意,用词应当准确。
    最小化长度 && 最大化信息量原则
    在保持一个标识符意思明确的同时,应当尽量缩短其长度。
    避免过于相似
    不要出现仅靠大小写区分的相似的标识符,例如“i”与“I”,“function”与“Function”等等。
    避免在不同级别的作用域中重名
    程序中不要出现名字完全相同的局部变量和全局变量,尽管两者的作用域不同而不会发生语法错误,但容易使人误解。
    正确命名具有互斥意义的标识符
    用正确的反义词组命名具有互斥意义的标识符,如:"nMinValue"和"nMaxValue","GetName()" 和 "SetName()" ....
    避免名字中出现数字编号
    尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为用数字编号最省事)。

    /结构
    除了异常类等个别情况(不希望用户把该类看作一个普通的、正常的类之情况)外,C++类/结构
    的命名应该遵循以下准则:
    C++类/结构的命名
    类的名称都要以大写字母“C”开头,后跟一个或多个单词。为便于界定,每个单词的首字母要大写。
    推荐的组成形式
    类的命名推荐用"名词"或"形容词+名词"的形式,例如:"CAnalyzer", "CFastVector" ....
    不同于C++类的概念,传统的C结构体只是一种将一组数据捆绑在一起的方式。传统C结构体的命名规则为:
    传统C结构体的命名
    传统C结构体的名称全部由大写字母组成,单词间使用下划线界定,例如:"SERVICE_STATUS", "DRIVER_INFO" ....
    函数
    函数的命名
    函数的名称由一个或多个单词组成。为便于界定,每个单词的首字母要大写。
    推荐的组成形式
    函数名应当使用"动词"或者"动词+名词"(动宾词组)的形式。例如:"GetName()", "SetValue()", "Erase()", "Reserve()" ....
    保护成员函数
    保护成员函数的开头应当加上一个下划线“_”以示区别,例如:"_SetState()" ....
    私有成员函数
    类似地,私有成员函数的开头应当加上两个下划线“__”,例如:"__DestroyImp()" ....
    虚函数
    虚函数习惯以“Do”开头,如:"DoRefresh()", "_DoEncryption()" ....
    回调和事件处理函数
    回调和事件处理函数习惯以单词“On”开头。例如:"_OnTimer()", "OnExit()" ....
    变量
    变量应该是程序中使用最多的标识符了,变量的命名规范可能是一套C++命名准则中最重要的部分:
    变量的命名
    变量名由作用域前缀+类型前缀+一个或多个单词组成。为便于界定,每个单词的首字母要大写。
    对于某些用途简单明了的局部变量,也可以使用简化的方式,如:i, j, k, x, y, z ....
    作用域前缀
    作用域前缀标明一个变量的可见范围。作用域可以有如下几种:
    前缀
    说明

    局部变量
    m_
    类的成员变量(member)
    sm_
    类的静态成员变量(static member)
    s_
    静态变量(static)
    g_
    外部全局变量(global)
    sg_
    静态全局变量(static global)
    gg_
    进程间共享的共享数据段全局变量(global global)
    除非不得已,否则应该尽可能少使用全局变量。
    类型前缀
    类型前缀标明一个变量的类型,可以有如下几种:
    前缀
    说明
    n
    整型和位域变量(number)
    e
    枚举型变量(enumeration)
    c
    字符型变量(char)
    b
    布尔型变量(bool)
    f
    浮点型变量(float)
    p
    指针型变量和迭代子(pointer)
    pfn
    特别针对指向函数的指针变量和函数对象指针(pointer of function)
    g
    数组(grid)
    i
    类的实例(instance)
    对于经常用到的类,也可以定义一些专门的前缀,如:std::string和std::wstring类的前缀可以定义为"st",std::vector类的前缀可以定义为"v"等等。
    类型前缀可以组合使用,例如"gc"表示字符数组,"ppn"表示指向整型的指针的指针等等。
    推荐的组成形式
    变量的名字应当使用"名词"或者"形容词+名词"。例如:"nCode", "m_nState","nMaxWidth" ....
    常量
    C++中引入了对常量的支持,常量的命名规则如下:
    常量的命名
    常量名由类型前缀+全大写字母组成,单词间通过下划线来界定,如:cDELIMITER, nMAX_BUFFER ....
    类型前缀的定义与变量命名规则中的相同。
    枚举、联合、typedef
    枚举、联合及typedef语句都是定义新类型的简单手段,它们的命名规则为:
    枚举、联合、typedef的命名
    枚举、联合、typedef语句生成的类型名由全大写字母组成,单词间通过下划线来界定,如:FAR_PROC, ERROR_TYPE ....
    宏、枚举值
    宏、枚举值的命名
    宏和枚举值由全大写字母组成,单词间通过下划线来界定,如:ERROR_UNKNOWN, OP_STOP ....

    无效附件更新 权限提升操作 删帖申请 举报以及其他需要帮助请加入QQ群:214663141 广告位招商 有意者联系

    该用户从未签到

    0

    主题

    36

    帖子

    564

    积分

    Rank: 4Rank: 4

    积分
    564
    发表于 2016-12-21 10:08:27 | 显示全部楼层
    本人主要使用C#,不知有没有相关的命名规则说明呀?

    1.发帖求助前要善用论坛搜索功能,那里可能会有你要找的答案;

    2.提问请组织好自己的逻辑,标题注明大概是什么问题,问题内容写详细,需提供问题症状、错误代码、截图、位置等等信息,不要让别人去猜你想问啥;

    3.如果你在论坛求助问题,并且已经从坛友或者管理的回复中解决了问题,请把帖子分类或者标题前面加上【已解决】

    4.回报帮助你解决问题的坛友,右下角【免费评分】赠与对方视觉币和热心值,伸手党遭人唾弃,做一个热心并受欢迎的人!

  • TA的每日心情
    点赞
    1 小时前
  • 签到天数: 955 天

    连续签到: 1 天

    [LV.10]以坛为家III

    379

    主题

    1551

    帖子

    7280

    积分

    Rank: 9

    积分
    7280

    突出贡献优秀版主荣誉管理论坛元老切换助手验证会员最佳新人

     楼主| 发表于 2016-12-21 11:44:38 | 显示全部楼层

    RE: C++命名规则

    vicky 发表于 2016-12-21 10:08
    本人主要使用C#,不知有没有相关的命名规则说明呀?

    C#的命名规范和C++是类似的,一般这种开发软件的命名规范都是接近的。
    无效附件更新 权限提升操作 删帖申请 举报以及其他需要帮助请加入QQ群:214663141 广告位招商 有意者联系
    您需要登录后才可以回帖 会员登录 | 会员注册

    本版积分规则

    建议您使用Chrome、Firefox、Edge、IE10及以上版本和360等主流浏览器浏览本网站

    51Halcon会员技术交流会员技术交流 | 51Halcon官方客服咨询官方客服咨询 | Halcon切换助手使用反馈切换助手使用

    有问题需要咨询站长?| 申请友链| 小黑屋| 手机版| Archiver|  

    粤ICP备15095995号-2 粤公网安备44030602000670号

    CopyRight © 2015-2020 51Halcon机器视觉. Tencent Cloud X3.4.

    快速回复 返回顶部 返回列表