命名规范——程序员的自我修养

之所以会有这样一篇笔记呢，是因为在各种不同的场景下，面临命名这件事情，有时候会犯迷糊，不知道该如何选择正确的方式命名。所以这篇笔记的目的就是为解决这个问题。

命名规范

命名规范包含了：目录、文件、变量、函数命名。
值得一提的是：命名规则没有谁对谁错，在项目中保持一致才是关键。

混乱或错误的命名不仅让我们对代码难以理解，更糟糕的是，会误导我们的思维，导致对代码的理解完全错误。
相反，良好的命名，则可以让我们的代码非常容易读懂，也能向读者正确表达事物以及逻辑的本质，从而使得代码的可维护性就大大增强，读命名好的文章是非常流畅的，会有一种享受的感觉。

目录

因为Windows，OSX 下文件夹不区分大小写，Linux 是区分的。所以在文件夹的命名上面，建议全部用小写。可以包含下划线(_)或连字符(-)。如果没有约定，(_)更好。

文件

文件的命名也是推荐和目录的连字符保持一致。Linux 文件系统推荐的文件命名是下划线(_)。

类

类型名称通常使用大写驼峰命名法

1
2

class MyClass
    ...

类成员

不管是静态还是非静态，类数据成员的命名都可以和普通变量一样，采用驼峰命名法：

1
2
3
4
5
6
7
8
9

class MyClass {
    public $myVariable;
    public static $myStaticVariable;
    
    public function myFunction($firstWord, $secondWord){
        //方法中的参数名推荐使用小驼峰命名法
        ...
    };
}

一般名称的前缀都是有第一规律的，如is（判断）、get（得到），set（设置）。

变量

变量的命名有两种方式：

• 下划线命名法：my_variable
• 小驼峰命名法：myVariable

但通常还是推荐使用，下划线命名法（全是小写）。

不同的语言也是有不同的规范，例如JavaScript 变量推荐驼峰命名法，CSS 推荐连字符(-)。

常量、全局常量

常量和全局常量通常使用全大写和下划线的方式来命名，例如：

1
2

const MY_CONSTANT;
define("DEFAULT_NUM", 10);

特殊变量

1
2
3
4
5

//引用变量

//静态变量

//全局变量

函数命名

函数的命名使用下划线命名法：

1
2
3

function my_function(){
    ...
}

补充说明

函数和方法的区别：
函数是一段可以重用的代码块，方法是在类里面的函数。

参考链接：

• PHP 命名规范
• 如何优雅的为变量和函数命名
• 命名约定 | Google开源项目风格指南
• 命名规范 | 程序员的自我修养