为什么编程都建议不要用拼音命名

news2024/11/19 3:39:50

一、场景

我们看看知乎答主举的搞笑例子,一句话全部都是shi,表达起来确实困难。

img

二、原因

上面这个回答,一句话全部都是“shi”,表达起来确实困难。并且让人误解

那么编程都建议不要用拼音命名,主要有以下原因:

  1. 可读性差:使用拼音命名的变量、函数名等很难被其他人理解,特别是如果阅读者的母语不是汉语。此外,由于拼音单词的语音相似,容易产生歧义。
  2. 维护困难:使用拼音命名的代码在后期维护时可能会出现问题。由于使用拼音命名的代码不易理解,维护者可能需要花费更多的时间和精力去理解代码的含义,甚至需要进行代码重构。
  3. 可靠性问题:拼音单词可能会存在多音字、同音字等问题,这会导致代码中的变量、函数名出现歧义或错误。

三、案例分析

img

假设有一个名为“cha”的函数,该函数被用于查找给定列表中是否存在某个元素。一个开发人员可能会选择使用“cha”作为该函数的名称,因为“查找”在汉语中的拼音是“cházhǎo”。

但是,如果这个函数被使用在一个国际化的项目中,其中有很多使用其他语言的开发人员,那么“cha”这个名称就会非常难以理解。例如,在英语中,“cha”这个单词并没有特定的含义,因此英语母语的开发人员可能会误解该函数的目的。

此外,即使是汉语母语的开发人员也可能会对这个名称感到困惑。在汉语中,“cha”这个词可以有很多不同的意义,包括查找、茶、插、叉等等。因此,如果其他开发人员不知道具体上下文,就很难理解“cha”这个名称的含义。

如果这个函数被重构为使用有意义的单词来命名,会更加容易理解和使用。例如,如果将“cha”这个函数重命名为“find”,那么无论是英语母语的开发人员还是汉语母语的开发人员都可以轻松地理解该函数的含义。

除了可读性和理解性问题,使用拼音命名还可能导致维护问题。假设在一个项目中,有一个使用拼音命名的变量“shu”,代表树。如果在后期需要修改这个变量,例如将其改为“tree”,那么所有使用“shu”变量的地方都需要进行修改。而如果使用有意义的单词来命名该变量,例如“tree”,那么只需要修改一处即可。

四、规范(Java)

img

1、类名需要使用大驼峰命名法(UpperCamelCase)风格。方法名、参数名、成员变量、局部变量需要使用小驼峰命名法(lowerCamelCase)。

2、测试方法名、常量、枚举名称需要使用蛇形命名法(snake_case),比如should_get_200_status_code_when_request_is_validCLIENT_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 前缀,否则部分框架解析会引起序列化错误。

如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式。

五、总结

使用拼音命名在编程中被认为是不好的实践,因为它可能导致可读性、理解性和维护性问题。在编写代码时,建议使用有意义的单词来命名变量、函数和其他标识符,以确保代码易于理解和维护。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/517124.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

数据结构_栈、队列和数组

目录 1. 栈 1.1 栈的定义 1.2 栈的基本操作 1.3 栈的顺序存储结构 1.3.1 顺序栈 1.3.2 顺序栈的基本运算 1.3.3 共享栈 1.4 栈的链式存储 1.5 栈相关应用 2. 队列 2.1 队列的定义 2.2 队列的基本操作 2.3 队列的顺序存储 2.4 循环队列 2.4.1 循环队列的操作 2.…

2023年全国职业院校技能大赛-大数据应用开发-数据可视化

可视化题目与以往相同,做法类似,我这里展示得到语句后处理优化以后的代码,以函数式来写可视化,比以前400-500多行代码简洁到100多行。其他题目见本栏目,那里面的代码都是没有优化后的,这次主要以效率和精简…

提升曝光率!掌握Facebook帖子关键词采集技巧

如何提高Facebook帖子的曝光率成为了每个营销人员的关注焦点。掌握Facebook帖子关键词采集技巧,可以帮助你更好地定位受众,增加帖子的曝光和点击率。在本文中,我们将详细介绍一些有效的技巧和策略,让你成为Facebook帖子关键词的专…

不到1分钟,帮你剪完旅行vlog,火山引擎全新 AI「神器」真的这么绝?

旅行时,想在社交平台发布一支精美的旅行 vlog,拍摄剪辑需要花费多长时间? 20 分钟?一小时?半天? 在火山引擎算法工程师眼里,可能 1 分钟都用不了,因为会有 AI 替你完成。 没错&#…

安装-唯一客服系统文档中心

环境要求 Mysql > 5.6IIS/Apache/Nginx(只推荐nginx) 宝塔一键部署 前往 【软件商店】>【一键部署】>【导入项目】 客服项目本身不需要PHP环境,因此PHP版本那里,随意根据自己环境写上就可以 导入完成以后,点击一键部署,填…

matlab实验四插值与数据拟合

一、实验目的及要求 一、实验的目的与要求: 1、掌握 MATLAB的一维数据插值法 2、通过比较不同次数的多项式拟合效果,了解多项式拟合的原理 3、掌握 MATLAB的多项式拟合的特点和方法 4、掌握 MATLAB的多项式表示与运算 二、实验原理 1、Matlab中&#xff…

基于QEMU的RISC-V架构linux系统开发(一)——RISC-V交叉编译器的安装

基于RISC-V交叉编译器包括32bit和64bit两种类型,其中每种类型又包括裸机版本(newlib)和动态链接库版本(linux glibc)。不同类型、版本的gcc的安装仅在配置文件上存在差异,具体安装流程(以64bit …

以数据思维和技能提升数据应用测试实践 | 京东云技术团队

作者:京东零售 周雪梅 以数据思维和技能提高测试覆盖率和效率。数据应用测试,功能测试主要聚焦在数据流向(输入和输出)。 一、背景 数据质量组当前主要承接黄金眼和商智中的供应链模块,商智包括PC(品牌版…

Access、Foxpro、Foxbase,2023年找到完美代替,有Excel基础即可

你还记得上世纪80年代的Foxbase和Foxpro吗? 数据库软件作为基础软件是计算机系统稳定运行的基石。 像Foxbase和Foxpro,很多计算机专业的前辈都应该听说过,当时的风靡程度一点也不亚于现在的微软office。 FoxPro和Foxbase是诞生于1984年。具…

玩机搞机-----安卓全机型 ADB FAST 各种指令解析说明与操作【二】基础联机

安卓全机型 玩机 搞机 ADB FAST 各种指令解析说明与操作_adb线刷命令_安卓机器的博客-CSDN博客 今天对上个帖子不足的地方进行补正。方便友友进行基础的联机操作,很多时候我们用adb指令的时候会有各种奇奇怪怪的问题。例如同一个机型,同一个指令。有时候…

使用svg在元素直接绘制连线箭头

注意&#xff1a;svg的图形绘制的点位置坐标是基于画布的位置坐标&#xff0c;相当于从左上角的点为起点。 先来个简单示例&#xff1a; 在点与点之间绘制连线箭头 <!DOCTYPE html> <html lang"en"> <head><meta charset"UTF-8">…

cookie、session、token的区别是什么

前言 今天就来说说session、cookie、token这三者之间的关系&#xff01;最近这仨玩意搞得头有点大&#x1f923; 1.为什么会有它们三个&#xff1f; 我们都知道 HTTP 协议是无状态的&#xff0c;所谓的无状态就是客户端每次想要与服务端通信&#xff0c;都必须重新与服务端链接…

JUC并发编程18 | AQS分析

尚硅谷&#xff08;140-155&#xff09; 18 AQS 前置知识 公平锁和非公平锁可重入锁自旋思想LockSupport双向链表设计模式——模块设计 18.1 AQS入门级别理论知识 AQS一般指的是 AbstractQueuedSynchronized AQS 是用来实现锁或者其他同步器组件的公共基础部分的抽象实现…

【企业信息化】第3集 世界排名第一的免费开源ERP: Odoo 16 POS终端管理系统

文章目录 前言一、概览二、硬件三、使用功能 前言 世界排名第一的免费开源ERP: Odoo 16 POS终端管理系统。几分钟内完成设置&#xff0c;几秒内完成销售。 一、概览 Odoo POS 基于智能界面&#xff0c;任何零售公司均可毫不费力地使用 因为其极具灵活性&#xff0c;您可配置 …

普通的项目非分布式项目中的技术点思考(学习随记)

学习路线 在学习Java的路程中&#xff0c;最开始学习JavaSe&#xff0c;在Java基础学完后&#xff0c;开始接触JavaWeb&#xff0c;开始接触框架&#xff0c;Spring框架&#xff0c;SpringBoot框架、数据库框架、在学习一下中间件&#xff0c;就可以完成工作中crud的基础操作&…

聚观早报|谷歌:全新大模型赋能「全家桶」;阿里巴巴取消CTO职位

今日要闻&#xff1a;谷歌 I/O&#xff1a;全新大模型赋能「全家桶」&#xff1b;阿里巴巴取消CTO职位&#xff1b;马斯克打造「美国微信」&#xff1b;奔驰将召回部分进口CLA汽车&#xff1b;奔驰将召回部分进口CLA汽车 谷歌 I/O&#xff1a;全新大模型赋能「全家桶」 北京时…

大模型也内卷,Vicuna训练及推理指南,效果碾压斯坦福羊驼

2023开年以来&#xff0c;大模型进入疯狂内卷状态&#xff0c;大模型的发布都要以“天”为单位进行迭代。 之前&#xff0c;尝试了从0到1复现斯坦福羊驼&#xff08;Stanford Alpaca 7B&#xff09; &#xff0c;下面我们来尝试从0到1复现Vicuna训练及推理。 Vicuna简介 继斯坦…

AOP深度学习

代理模式 静态代理&#xff1a;静态代理确实实现了解耦&#xff0c;但是由于代码都写死了&#xff0c;完全不具备任何的灵活性。就拿日志功能来说&#xff0c;将来其他地方也需要附加日志&#xff0c;那还得再声明更多个静态代理类&#xff0c;那就产生了大量重复的代码&#…

wps js宏编辑器案例2-单元格读写-随机选人

本案例讲述某企业的一个真实案例&#xff0c;该企业每周二早上有安全宣贯会议&#xff0c;差不多10来分钟左右&#xff0c;每次安全会上人事部门都会点名&#xff0c;那么问题来了&#xff0c;点名的名单哪儿来&#xff1f;为此&#xff0c;编写了一个简单js宏应用&#xff0c;…

易基因:DNA甲基化和转录组分析揭示野生草莓干旱胁迫分子调控机制|植物抗逆

大家好&#xff0c;这里专注表观组学十余年&#xff0c;领跑多组学科研服务的易基因。 干旱胁迫是对农业生产产生不利影响的关键环境因素。为此&#xff0c;植物发展出各种响应机制&#xff08;干旱逃逸、避免、耐受和回复&#xff09;&#xff0c;以通过进化增强抗旱性&#…