【开发规范】命名规范

TracingOrigins

已于 2023-11-16 01:53:22 修改

阅读量2.7k

点赞数 1

分类专栏：开发规范文章标签：开发语言

于 2022-04-24 18:13:54 首次发布

本文链接：https://blog.csdn.net/tracingorigins/article/details/124388901

版权

开发规范专栏收录该内容

1 篇文章 0 订阅

订阅专栏

本文介绍了常见的代码命名规范，包括驼峰命名法（小驼峰和大驼峰）、蛇形命名法和串式命名法，并提供了Java和Python的命名规则示例。强调了命名规范在提高代码可读性和减少注释需求方面的重要性。此外，还给出了不同语言场景下的命名建议，如Java的包名和Python的变量命名。最后，提出了在不同编程语言间保持一致性的命名习惯的建议。

摘要由CSDN通过智能技术生成

前言

关于代码命名，我相信是经常困扰很多小伙伴的一个问题，尤其是对于强迫症晚期患者。怎么说呢，每次小编在写代码之前，总会在想啊想啊，用什么命名法好呢？对于经常在C++、Java、Python等主流语言上切换的强迫症来说，换个语言换种命名风格简直不要太混乱。

今天就来梳理一下常见的代码命名规范以及适用范围吧。

常见命名规范

为什么需要命名规范呢？世界级软件大师 Martin Fowler 大神都说过 CS 领域有两大最难的事情，一是缓存失效，一是程序命名。
在这里插入图片描述
《Clean Code》这本书明确指出：

代码的注释不是越详细越好。实际上好的代码本身就是注释，我们要尽量规范和美化自己的代码来减少不必要的注释。若编程语言足够有表达力，就不需要注释，尽量通过代码来阐述。

要想让你的编程语言足够有表达力，良好的命名规范是必不可少的。同时，花几分钟学学规范的命名，也能让你的代码看起来赏心悦目，何乐而不为呢。

1. 驼峰命名法（CamelCase）

骆驼式命名法（Camel-Case）又称驼峰式命名法，是电脑程式编写时的一套命名规则（惯例）。正如它的名称CamelCase所表示的那样，是指混合使用大小写字母来构成变量和函数的名字。程序员们为了自己的代码能更容易的在同行之间交流，所以多采取统一的可读性比较好的命名方式。

它又可以分为以下几种。

1.1 小驼峰命名法（lowerCamelCase）

除第一个单词之外，其他单词首字母大写。方法名、参数名、成员变量、局部变量需要使用小驼峰命名法（lowerCamelCase）。例如：

getUserInfo()
createCustomThreadPool()
findAllByUserName(String userName)
TaskRepository taskRepository;

1.2 大驼峰命名法（CamelCase）

相比小驼峰法，大驼峰法（即帕斯卡命名法）把第一个单词的首字母也大写了。常用于类名，命名空间等。例如：

class TaskDateToSend{}
class TaskLabelToSend{}
SettingRepository

2. 蛇形命名法（snake_case）

蛇形法是全由小写字母和下划线组成，在两个单词之间用下滑线连接即可。测试方法名、常量、枚举名称需要使用蛇形命名法（snake_case）。例如：

first_name
last_name
MAX_ITERATION
LAST_DATA

3. 串式命名法（kebab-case）

在串式命名法中，各个单词之间通过下划线“-”连接，例如：

hello-world
first-project

建议项目文件夹名称使用串式命名法（kebab-case），比如 dubbo 项目的各个模块的命名是下面这样的：
在这里插入图片描述

总结一下

在这里插入图片描述

语言场景

给出各个场景下的命名规则，大家要养成习惯。事实上，如果经常在各个语言上切换的话，真的可能搞混。所以今天就Mark一下吧。

Java命名规范

总体命名规范

类名需要使用大驼峰命名法（UpperCamelCase）风格。
方法名、参数名、成员变量、局部变量需要使用小驼峰命名法（lowerCamelCase）。
测试方法名、常量、枚举名称需要使用蛇形命名法（snake_case），比如test_get_user()、TIME_LIMIT。并且，测试方法名称要求全部小写，常量以及枚举名称需要全部大写。
项目文件夹名称使用串式命名法（kebab-case），比如dubbo-registry。
包名统一使用小写，尽量使用单个名词作为包名，各个单词通过 “.” 分隔符连接，并且各个单词必须为单数。
抽象类命名使用 Abstract 开头。如：public abstract class AbstractClient extends AbstractEndpoint{}。
异常类命名使用 Exception 结尾。如：public class NoSuchMethodException extends RuntimeException{}。
测试类命名以它要测试的类的名称开始，以 Test 结尾。如：public class AnnotationUtilsTest{}。
所有命名规则必须遵循以下规则：
名称只能由字母、数字、下划线、$符号组成.
不能以数字开头.
名称不能使用Java中的关键字.
坚决不允许出现中文及拼音命名.

包名命名规范

Java的包名由小写单词组成，包的路径符合所开发的系统模块的定义，以便通过包名可得知其属于哪个模块，从而方便到对应包里找相应的实现类。

常规包名

为了保障每个Java Package命名的唯一性,在Java编程规范中要求开发人员在自己定义的包名前加上唯一的前缀.由于互联网上的域名称是不会重复的,所以多数开发人员采用自己公司在互联网上的域名称作为自己程序包的唯一前缀.例如 : com.sun.swt…

公司项目
com：公司项目,copyright由项目发起的公司所有.
包名：com.公司名.项目名.模块名…
团队项目
team：团队项目,指由团队发起,并由该团队开发的项目,copyright属于该团队所有
包名：team.团队名.项目名.模块名…

自定义包名

一般公司命名为com.公司名.项目名.模块名…那我们个人的项目又怎么命名呢?

个人的英语单词有individual、personal、private、one-man,进一步对以上四个单词词意进行分析并在保证了唯一性,继而使用每个单词的前4个字母作为前缀,与com也做了区分.

示例如下所示:

indi：个体项目,指个人发起,但非自己独自完成的项目,可公开或私有项目,copyright主要属于发起者.
包名：indi.发起者名.项目名.模块名…
pers：个人项目,指个人发起,独自完成,可分享的项目,copyright主要属于个人.
包名：pers.个人名.项目名.模块名…
priv：私有项目,指个人发起,独自完成,非公开的私人使用的项目,copyright属于个人.
包名：priv.个人名.项目名.模块名…
onem：与indi相同，推荐使用indi.

Python命名规范

类：总是使用首字母大写单词串。如MyClass、ClassName。内部类可以使用额外的前导下划线。
函数和方法：小写+下划线，如method_name。
函数参数：小写+下划线，如function_parameter_name。如果一个函数的参数名称和保留的关键字冲突，通常使用一个后缀下划线，如random_。
全局变量：对于from M import *导入语句，如果想阻止导入模块内的全局变量可以使用旧有的规范，在全局变量上加一个前导的下划线，如_var_name。应避免使用全局变量。
变量：小写，由下划线连接各个单词。如color、this_is_a_variable。注意：
1. 不论是类成员变量还是全局变量，均不使用 m 或 g 前缀。
2. 私有类成员使用单一下划线前缀标识。
3. 变量名不应带有类型信息，因为Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。
常量：常量名所有字母大写，由下划线连接各个单词如MAX_OVERFLOW，TOTAL。
异常：以“Error”作为后缀。
文件名：全小写,可使用下划线
包：应该是简短的、小写的名字。如果下划线可以改善可读性可以加入，如mypackage。
模块：与包的规范同，如mymodule。
缩写：命名应当尽量使用全拼写的单词，缩写的情况有如下两种：
1. 常用的缩写，如XML、ID等，在命名时也应只大写首字母，如XmlParser。
2. 命名中含有长单词，对某个单词进行缩写。这时应使用约定成俗的缩写方式。例如：function 缩写为 fn text 缩写为 txt object 缩写为 obj count 缩写为 cnt number 缩写为 num，等。
前导后缀下划线：
1. 一个前导下划线：表示非公有。
2. 一个后缀下划线：避免关键字冲突。
3. 两个前导下划线：当命名一个类属性引起名称冲突时使用。
4. 两个前导和后缀下划线：“魔”（有特殊用图）对象或者属性，例如__init__或者__file__。绝对不要创造这样的名字，而只是使用它们。注意：关于下划线的使用存在一些争议。
特定命名方式：主要是指 xxx 形式的系统保留字命名法。项目中也可以使用这种命名，它的意义在于这种形式的变量是只读的，这种形式的类成员函数尽量不要重载。如 class Base(object): def init(self, id, parent = None): self.id = id self.parent = parent def message(self, msgid): 其中 id、parent 和 message 都采用了系统保留字命名法。