zoukankan      html  css  js  c++  java
  • C/C++命名规范-C语言基础

    在这里插入图片描述这一篇文章想要介绍的是编写代码的时候业界比较常用的一些命名规范,以及个人平时的一些命名规范。涉及“驼峰命名法”、“下划线命名法”、“帕斯卡命名法”、“匈牙利命名法”的介绍和见解。属于C语言基础篇(持续更新


    刚刚开始学习编程的时候,我的第一个老师便强调过,命名要规范,需要做到见名知意,当时不以为然。不就给变量起个名字吗?26个字母什么时候用完过,再不够加个1234567不就行了吗?a1,a2,a3什么时候用的完?但是嘛,平时做做练习随便命名倒还行,毕竟代码量不多。当你的代码量多起来了,开始模块化编程开始写项目的时候,规范的命名就显得很重要了。

    规范的命名可以让你在代码调试的过程中快速的知道当前变量的功能和定义时的目的。而不需要在这个文件看到一个变量,又要赶紧翻到别的文件去看看这个变量定义来是干嘛的。

    对于规范命名,有很多编程入门书籍都有讲到。为此阿里还专程编辑整理出了一本书《阿里巴巴Java开发手册》来规范业界的代码习惯。可见代码规范化有多重要了。

    好了,说了那么多有的没的,其实意义也不大。因为会看到这个标题而点进来看的人,本身就是那些已经意识到写代码命名需要规范的人了。我们进入正题吧!

    这篇文章,仅仅是想要分享一下我自己平时做项目的一些命名习惯,这里面的内容并非什么资深的专业规范,更没有什么权威性。仅仅只是个人借鉴网上的一些命名方法,以及平时使用库函数时对于前人一些命名规范的效仿,再结合自身的编程习惯,给自己制定的一套命名规则。


    在分享我自己的命名规范之前,我们先来简单了解一下几个比较出名的命名方法。

    常用的命名方法


    驼峰命名法:

    char myName[10] = {“ShiYi”};

    驼峰命名法的特点是:变量名由多个单词组成,其第一个单词的首字母小写,后面每一个单词的首字母都要大写,由于其外形看起来像驼峰一样上下起伏故得名。这也是大家平时编程开发的时候用的比较多的一个命名方法。因为这种命名方法使用起来非常顺手,而且外形也很好看。


    帕斯卡命名法:

    char MyName[10] = {“ShiYi”};

    名字听起来很高大上,实际上就是把驼峰命名法的第一个单词的首字母也改为大写。所以也称之为大驼峰命名法。但由于人们在输入习惯上面,通常在输入第一个单词的时候,不会刻意切换大小写,所以没有驼峰命名法使用起来顺手。


    下划线命名法:

    char my_name[10] = {“ShiYi”};

    名如其意,每个单词之间用下划线隔开。但是由于有下划线的加入会让变量整体看起来过长,不过这种命名方法却有通俗易懂的效果,由于每两个单词之间用一小块空白隔开,所以即便是一个完全没有命名规范认知的新手,也能一眼就看出这个变量想要表达的东西。


    匈牙利命名法:

    char cMyName[10] = {“ShiYi”};

    这个命名法就有点意思了,好像是一个匈牙利的程序员在很久以前发明的。其特点是用名字的前一到两个字母来表示变量的类型,后面表示变量意思的单词首字母大写。

    这个命名方法也是业界被批判最多的一个命名方法了,具体原因说起来有点长,主要还是由于数据类型的不断增加以及如今IDE功能的不断完善导致的,前者导致了这种命名方法的缺点不断放大,后者导致这种命名方法的优点不断缩小。而且由于C++中模版关键字“template”的引入,使得变量类型的不确定性大大增加,更加放大了这种命名方法的缺点。对于这个命名方法,我不做太多评价,我觉得嘛,出发点是挺好的,只是实在有一些致命的缺点还没法解决。


    好了,目前业界比较常见的几个命名规范都已经有所了解了。

    下面就是我自己命名规范了,这是我很久以前刚刚开始学习编程的时候,弄完第一个项目之后,制定给自己的,后面的学习过程中也不断的完善更新着。对于C语言的开发,这套规范完全够用了。但是后面接触到了C++和Qt之后,类型和特性什么的多了之后,渐渐的也开始有点力不从心了。

    不过这个问题也不是一时半会能真正解决的,对于命名规范的书籍有很多,但是业界到目前为止也没有一套真正公认合适好用的大家普遍遵循的命名规范。这也一直是一个问题,几乎都处于家有家规国有国法的现状,不同的公司不同的团队不同企业有其自己制定的命名规范,只要开发团队之间协调好即可。

    所以我这套命名规范目前来说只适用于个人,适用范围也比较窄,仅仅涉及常用的类型,对于一些不太常用的类型很少涉及,其实我也不太愿意涉及太多的内容,一个体系如果过于庞大便会变得过于笨重,难以变通不够灵活。我宁愿它简洁一点,高效一点,也实用一点。虽然以后有什么更好的想法可能还是会更新的,不过现在就只到这里了。。。


    以下是我的命名规范:


    总体规范:

    • 所有命名中第一个字母都用以说明属性
    • 带下画线的都是类型
    • 不带下画线的都是对象(这里的对象也包含变量(下同))
    • 第一个字母大写表示特殊类型的对象
    • 第一个字母小写表示普通类型的对象

    常见类型命名规范

    • 函数命名规范:帕斯卡加下画线

        int my_Function(void);

    标志是有下画线的同时用驼峰命名

    • 类、结构体、联合体命名规范:以大写字母C或S或L开头接上帕斯卡加下画线

      类:

        class CMy_Class{}

      结构体:

        struct SMy_Struct{};

      链表:

        struct LMy_List{};
        首字母大写C表示类,S表示结构体,L表示链表

    标志是两个大写开始


    特殊类型命名规范

    • 宏定义和常量和枚举命名规范:全部大写

        #define MYMACRO 0

    标志是全部大写

    • typedef重命名对象:还没想好
    • 引用类型:还没想好

    常见对象命名规范

    • 普通类型对象命名规范:匈牙利加驼峰(小写类型加驼峰)

        int imyName = 0;
        小写的首字母表示类型,后面接驼峰

    标志是两个小写开始


    特殊类型对象命名规范:

    • 结构体对象的命名规范:小写s加帕斯卡

        SMy_Struct sMyStruct = NULL;

    • 类的对象命名规范:小写c加帕斯卡

        cMyClass = new CMy_Class;

    • 链表对象的命名规范:小写l加帕斯卡

        LMy_List lMyList = NULL;

    标志是一个小写字母开头接大写


    总结一下:我用这个规范定义名字,先看有没有下划线,如果有则说明这是个类型或者函数,然后看首字母,小写是函数,大写就是别的,再通过类型来判断。如果名字里面没有下划线,则说明这是个对象,然后看首字母,如果是小写,普通数据类型,如果是大写这是别的,再通过类型来判断。


     原博客始发于CSDN,在如今博客界的转载抄袭泛滥的环境下,原创不易,点个赞再走呗。以下是博客首页的链接。


    零BUG是原则性问题。

  • 相关阅读:
    设置linux文件权限,使得同一用户组的可以在文件夹内自由增删文件(夹)
    opencv3.4.8编译opencv-contrib并使用sift
    安装anaconda简单教程
    Arch升级时断开链接恢复
    配置远程连接容器内镜像(映射容器内系统的22端口到宿主机上)
    t-SNE是什么?
    远程连接路由器下的主机
    windows下,本地PyCharm连接远程服务器显示图片
    卷积网络中,关于BatchNorm的训练与加载
    学习Keras
  • 原文地址:https://www.cnblogs.com/L-0x0b/p/10858517.html
Copyright © 2011-2022 走看看