一、场景
我们看看知乎答主举的搞笑例子，一句话全部都是shi，表达起来确实困难。
image.png
二、原因
上面这个回答，一句话全部都是“shi”，表达起来确实困难。并且让人误解
那么编程都建议不要用拼音命名，主要有以下原因：
-
可读性差：使用拼音命名的变量、函数名等很难被其他人理解，特别是如果阅读者的母语不是汉语。此外，由于拼音单词的语音相似，容易产生歧义。
-
维护困难：使用拼音命名的代码在后期维护时可能会出现问题。由于使用拼音命名的代码不易理解，维护者可能需要花费更多的时间和精力去理解代码的含义，甚至需要进行代码重构。
-
可靠性问题：拼音单词可能会存在多音字、同音字等问题，这会导致代码中的变量、函数名出现歧义或错误。
三、案例分析
image.png
假设有一个名为“cha”的函数，该函数被用于查找给定列表中是否存在某个元素。一个开发人员可能会选择使用“cha”作为该函数的名称，因为“查找”在汉语中的拼音是“cházhǎo”。
但是，如果这个函数被使用在一个国际化的项目中，其中有很多使用其他语言的开发人员，那么“cha”这个名称就会非常难以理解。例如，在英语中，“cha”这个单词并没有特定的含义，因此英语母语的开发人员可能会误解该函数的目的。
此外，即使是汉语母语的开发人员也可能会对这个名称感到困惑。在汉语中，“cha”这个词可以有很多不同的意义，包括查找、茶、插、叉等等。因此，如果其他开发人员不知道具体上下文，就很难理解“cha”这个名称的含义。
如果这个函数被重构为使用有意义的单词来命名，会更加容易理解和使用。例如，如果将“cha”这个函数重命名为“find”，那么无论是英语母语的开发人员还是汉语母语的开发人员都可以轻松地理解该函数的含义。
除了可读性和理解性问题，使用拼音命名还可能导致维护问题。假设在一个项目中，有一个使用拼音命名的变量“shu”，代表树。如果在后期需要修改这个变量，例如将其改为“tree”，那么所有使用“shu”变量的地方都需要进行修改。而如果使用有意义的单词来命名该变量，例如“tree”，那么只需要修改一处即可。
四、规范（Java）
[图片上传失败...(image-d42a8a-1681438137333)]
1、类名需要使用大驼峰命名法（UpperCamelCase）风格。方法名、参数名、成员变量、局部变量需要使用小驼峰命名法（lowerCamelCase）。
2、测试方法名、常量、枚举名称需要使用蛇形命名法（snake_case），比如should_get_200_status_code_when_request_is_valid、CLIENT_CONNECT_SERVER_FAILURE。并且，测试方法名称要求全部小写，常量以及枚举名称需要全部大写。
3、项目文件夹名称使用串式命名法（kebab-case），比如dubbo-registry。
4、包名统一使用小写，尽量使用单个名词作为包名，各个单词通过 "." 分隔符连接，并且各个单词必须为单数。
正例：org.apache.dubbo.common.threadlocal
反例：org.apache_dubbo.Common.threadLocals
5、抽象类命名使用 Abstract 开头。
public class AbstractWrapper extends Wrapper{
}
6、异常类命名使用 Exception 结尾。
public class MybatisPlusException extends RuntimeException {
private static final long serialVersionUID = 1L;
public MybatisPlusException(String message) {
super(message);
}
public MybatisPlusException(Throwable throwable) {
super(throwable);
}
public MybatisPlusException(String message, Throwable throwable) {
super(message, throwable);
}
}
7、测试类命名以它要测试的类的名称开始，以 Test 结尾。
public class AnnotationUtilsTest {
......
}
POJO 类中布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列化错误。
如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。
五、总结
使用拼音命名在编程中被认为是不好的实践，因为它可能导致可读性、理解性和维护性问题。在编写代码时，建议使用有意义的单词来命名变量、函数和其他标识符，以确保代码易于理解和维护。
网友评论