如何写出好的变量名

最新推荐文章于 2024-08-15 19:27:57 发布
原创 最新推荐文章于 2024-08-15 19:27:57 发布 · 846 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#1024程序员节

前言

本文内容主要是摘抄自《代码大全》中与变量名相关章节的内容，阐述当需要一个好的变量名需要注意哪些点。

变量名的力量

一个好的变量名是可读的，易记的和恰如其分的。考虑变量名时，名字需要完全、准确地描述出该变量所代表的事物。

x = xx - xxx;

balance = balance - lastpayment

一般对变量的描述就是最佳的变量名。 并且注意长度。

一个好的变量名通常反应的是问题，而不是解决方案，其通常表达的是”什么“（what）而不是”如何“（how）。 例如财务软件中，calcVal 变量名就比 sum 变量名更能表现问题领域。 员工数据记录则取名 employeeData 而不是简单的 data。

短的变量名也不总是不好的，例如 i, j ,k 这类变量名，一般就是在表示普通的循环计数器或者是数组下标，并且在这几行之外它没有任何作用。

程序中表示计算结果的变量： 总额，平均值，最大值等，如果要用类似，Total, sum, average, max ,min, record, string, pointer 这类的限定词来修改某名字，记住把限定词放在名字的最后。 就不会出现风格不统一同时使用 totalRevenue 和 revenuetotal 而产生的歧义。 且风格一致，提高可读性。

Num 限定词的位置也约定俗成。Num 放在变量名的开始位置表示总数： numCustomers 是员工总数。 Num 放在变量名结束的位置表示下标，customerNum 表示员工的序号。 当然由于这样会带来麻烦，更好的办法也是避开这个问题，通过 Count 或者 total 表示总数， index 来表示某个特定员工。

对仗词会让命名更加一致性，方便理解和记忆，下面是书中记录的常用的对仗词：

begin / end | | opened / closed

first / last | | visible / invisble

locked / unlocked | | source / target

min / max | | up / down

next / previous | | old / new

特定数据类型命名

循环变量

i,j,k 像是约定俗成的循环变量命名方式，如果循环体并不长，且循环变量不会在循环之外使用，那么可以用 i,j,k 简单表示。相反一旦循环体比较长，或者在循环体外还要使用，就需要一个更有意义的名字了。否则代码一长，编程人员可能就忘记了 i 本来具有的含义，更容易出错。

状态变量

要为状态变量取一个比 flag 更好的名字。标记的名字中不应该含有 flag, 因为从中丝毫看不出该标记是做什么的。为了清楚起见，标记应该用枚举类型、具名常量(const xxx)。

// NO
if(flag) ...
if(statusFlag & 0x0F) ...
if(printFlag == 16) ...
if(computeFlag == 0) ...

//Yes
if(dataReady) ...
if(characterType & PRINTABLE_CHAR) ...
if(reportType == ReportType_Annual) ...
if(recalcNeeded == false) ...

临时变量

临时变量用于存储计算的中间结果。它们通常被赋予 tmp，x 等一些模糊且缺乏描述性的名字。临时变量也最好是可以给出一个更加准确的变量名来增加代码的可读性。

布尔变量

一些比较常用的布尔变量名： done，error，found，success 等。 上面都是给布尔变量赋予隐含”真/假“ 含义的名字。 done 这样要么是 true 要么是 false。 如果是 status， sourceFile 这样的名字，是没有明确的 true 或者 false 在里面的，每件事情都有状态， true 就代表状态是 OK 的吗？不一定。 可以将 status 替换成 error 或者是 statusOK。

有一些喜欢在布尔名前面加上 is。 这边变量名变成了一个问题： isdone? isfound? 这种做法的好处是避免了模糊不清的名字， isStatus。 但是可读性略差， if(isFound) 可读性略差于 if(found)。

与语言无关的指导原则

区分变量和子程序名字，区分类和对象，标识全局变量，标识成员变量，标识类型声明等，上述未必有固定的风格，或者答案，有一些建议是加前缀，例如全局加 g_ 前缀，类型加 t_ 前缀，成员变量加 m_ 前缀等，包括是驼峰命名，还是下划线间隔，等等，选择一种格式并统坚持下去，就可以增加代码可读性。

从某种程度上，要求使用短变量名是早期计算的遗留物。早期语言一般要求把变量名长度限制在 2 ~ 8 个字符。于是慢慢有了一些简短的缩写名字。而缩写也有一般指导原则：

  • 使用标准的缩写（字典中常见的缩写）
  • 去掉素有非前置元音（computer → cmptr， screen→scrn）
  • 去掉虚词：and, or , the 等
  • 使用后每个单词的第一个或前几个字母
  • 统一地使用每个单词的第一、第二或第三个字母后截断
  • 使用名字中每一个重要单词，最多不超过三个
  • 去掉无用的后缀 - ing, ed 等

上述一些原则本身就有冲突的地方，所以不需要满足所有的原则，选择其中一条即可。

  • 避免使用令人误解的名字或缩写
  • 避免使用具有相似含义的名字：recordNum 和 Numrecoeds 同时使用， fileNumber 和 fileIndex 等
  • 避免使用不同含义却相似名字的变量。
  • 避免使用发音相近的名字： wrap 和 rap
  • 避免在名字中使用数字。
  • 避免在名字中拼错单词。
  • 不要仅靠大小写来区分变量名。
  • 不要使用与变量含义完全无关的名字。

代码阅读的次数远远多于编写的次数。确保你所取的名字更侧重于阅读而不是编写方便。

以上只是书中列出的一些点，可以让我们有意识的去注意哪些点，想要写出可读性好，风格一致的代码还是在日常接触优秀开源项目源码时多加留意，学习和模仿。

10个秘诀教你写出超棒的C#变量名，你学会了吗？
java专栏
01-16 1610
🔥关注墨瑾轩，带你探索编程的奥秘！🚀🔥超萌技术攻略，轻松晋级编程高手🚀🔥技术宝库已备好，就等你来挖掘🚀🔥订阅墨瑾轩，智趣学习不孤单🚀🔥即刻启航，编程之旅更有趣🚀嘿，小伙伴们！今天咱们来聊聊一个超级重要的主题——如何给C#中的变量起一个既专业又易懂的名字。是不是觉得这听起来有点儿像给宠物取名？其实还真有点类似呢！好的变量命名不仅能让代码更加清晰易读，还能让你在团队协作中成为大家心目中的“代码诗人”。那究竟怎样才能做到这一点呢？接下来就让我们一起探索吧！
【程序员必读】如何利用AI快速生成有效的变量名？程序员必看小技巧！
万物皆有灵
09-19 1382
变量名不仅要符合语言的命名规则，还要具备可读性和语义性。今天，我将分享一个小技巧，教你如何利用人工智能（AI）快速生成有效的变量名
给变量取个名字(变量命名)
wuxiaobingandbob的专栏
05-13 2871
给变量取个名字(变量命名) 我们为了区分盒子，可以用BOX1,BOX2等名称代表不同盒子，BOX1就是盒子的名字（也就是变量的名字）。 我们赶快给变量取个好名字吧!变量名字可以任意取，只不过取名字要遵循一些规则: 1.必须以字母、下划线或美元符号开头，后面可以跟字母、下划线、美元符号和数字。如下: 正确: mysum
优雅的变量命名
冰冰小宝贝的博客
11-15 1028
前言 优秀的代码往往是最通俗易懂的代码，在于它的易于维护。在开发过程中，变量/方法优秀的命名往往有助于理解该变量/方法的用途，起到命名即注释的作用。而糟糕的命名往往会让人摸不着头脑。为了提高代码的可维护性，我们需要更优雅的命名方式。 一、通用规则 1. 有意义 起一个有意义的变量名这条相信绝大多数开发者都能做到，即变量名有实际的指代意义，在此不再赘述。 2. 指代具体 命名时需要使其更加具体详尽，可以具体到所在的模块，或者能表达出其逻辑/功能。 /* bad */ .title {} /* good */
什么样的变量名是好的变量名？
黑马程序员官方博客
07-19 294
代码在执行前，通常要经过作者深思熟虑的编写，甚至同行评审（code review）过后，确保没有明显的问题才会交给计算机执行。计算机只负责编译执行，才不管你的代码写得好不好看，有没有逻辑问题，扩展性如何等等。从这个角度说，良好的命名规范可以提高代码质量，减少软件缺陷。好了，装X到此结束。以我多年的搬砖经验，见过一些在命名方面比较讲究的框架和库，比如微软的 .Net Framework，C# 的命名，用词准确、精炼，看起来就很舒服。在生活中，漂亮的人名让人赏心悦目，还有着丰富的含义，让人印象深刻。
(1).[11章]变量命名的力量：选择好变量名的注意事项（p259）
TCMY的专栏
03-11 354
变量命名 看似简单的事，但为变量取好的名字是编程中的一项重要事项。好的名字对代码编写、维护都将带来很大的好处。 好变量命名的技巧和原则 该名称要完全、准确地描述该变量所代表的事务，没有歧义； 一个好的名字反映的通常都是问题，而不是解决方案。要表达是“什么(what)”，而不是“如何(how)”； 适当的名称长度。太短不能描述清代表的意义及与其它变量关系，太长难写； 变量命的败笔 用简单的X1、XX、或太短的晦涩缩写 ...
起个变量名，好的代码应该是这样的
蜜糖的代码注释
01-24 513
先起一个名字 在进行项目编写的过程中，免不了的就是要进行各种方法、变量的命名。你一定经历过对变量命名无比困难的时候。而有的时候命名就看起来很轻松，比如对新增一个领域实体的时候。那用户（user）来举例子，可能还没有进行更多的思考，但 addUser的方法就已经创建了。工作完成，可喜可贺。 但真的是这样吗？有多少同学在进行后续的代码翻阅的时候，反而发现别的同学的接口出现了 saveXxx的方法？该跟他保持一致吗？还是继续我行我素？ 如果在团队中的命名规范不明确的话，这种确实会出现。而比表面上看起来更严重的问题
python中变量名存储在哪里_变量名储存在哪里，变量的储存机制是什么？
weixin_40008969的博客
12-05 1692
转载来的，基本解决了我的疑惑，希望帮到有同样疑惑的人C 里面 ---变量名-- 和 --地址-- 的关系探讨变量名不占空间变量：用来标识(identify)一块内存区域，这块区域的值一般是可以更改的，这就是它“变”的由来，但是我们可以通过使用如const等一些修饰符号来限定这一内存区域的操作特性(characteristic)，即变量的操作特性。用const修饰的使变量不能更改的就和常量一样的变量...
变量名存放在哪里？
weixin_33724659的博客
11-28 7100
变量名存放在哪里？ 这是一个有意思且无聊的问题，之前在网上看到有人问道这个问题，比如说在PHP里面我们写下 $name = "名字" 这样的代码语句，在代码运行的时候，$name 在哪里呢？ 了解了变量在内存中存储方式的人会知道，一般变量的值在存放在栈内存里面的，但是名字呢？ 针对这个问题，咱们先要区分一下编译型语言和解释型语言，这2种语言运行方式完全不一样，C/C++是典型的编译型语言，而且PH...
写出更好的JavaScript程序之undefined篇（中）
12-11
写在前面的依然是消歧义声明：本文中...“undefined”指名为“undefined”的值（全局或本地变量），而“未定义”指type(…) == “undefined”的概念值；“output”是向我们显示传入参数的函数，其实就是“alert”的同
如何定义一个好的变量名
weixin_30414635的博客
11-09 252
转载于：http://www.cnblogs.com/lijianwu/p/5715224.html 如何定义一个好的变量名 　　在日常编程中最烦恼的就是给变量取名，一段好代码，既要能完美地运行，还要能较容易地维护。这就意味着需要让日后维护代码的人能很快地看懂你的代 码，而且，在团队合作中，其他开发者也会经常阅读你那部分代码。如果你的代码中充满了a,b,c,a1,a2,a3...那简直就...
变量如何命名？
LmissL的博客
09-18 274
变量命名规范？ 由字母（A-Za-z）、数字（0-9）、下划线（ _ ）、美元符号$组成。如： userAge，num01，_name 严格区分大小写。var app；和var App；是两个变量 不能以数字开头、保留字。例如：var、for、while 变量名必须有意义。MMD BBD nl→age 遵守驼峰命名法。首字母小写，后面单词的首字母需要大写。如：myFirstName ...
起个名字好难：关于变量命名的思考与总结
邝同学的漫漫编程路
10-09 1031
最近半年多，随着编写代码工程变大，代码行数也在增加。类名、函数形参、成员变量名、全局变量等等开始变得混淆不清，自己也有时搞不清变量的意义、作用域等等。故，在网上翻阅了大牛们关于变量命名的一些文章，思考并总结了，写下了这篇关于代码中变量命名的文章。希望与所有与我有共同困惑的人共勉。 一、语法过关     在所有关于语言类入门书籍中，一般最开始就会提到关于命名的语法规则，C++的语法规则大致如下：
你还在为了生成变量名所烦恼吗？一篇文章教会你如何生成变量名
万物皆有灵
08-15 2751
通过这个教程，你将学会如何利用工作流，利用气泡文本组件、输入文本组件、按钮组件、设置变量组件和AI组件，快速生成符合编程语言规范的变量名。一次5分钟的编排，将达到终生受益的效果。
想提升JavaScript技能，你得掌握这5大关键概念
读芯术的博客
10-03 2163
全文共3576字，预计学习时长9分钟 图源：unsplash 学习一种语言或框架的核心概念，从而高效编写代码，这是个不错的想法。然而，如果你想快速学习新东西，必然需要阅读冗长的说明，这会很麻烦。因此，本文将简单地解释一些核心概念帮助你更轻松地去理解它们。 这些概念将改变你的编码方式，助你写出高质代码，成为高效的开发人员。基于在编码领域的受欢迎度，笔者挑选出了下面这些概念。一起开始吧！ 1．解构 从对象中提取属性有几种方法，解构就是其中之一。它有助于清晰地提取对象的属性、从数组中赋值或将对象的属
如何优雅的起个变量名？
道阻且长，行则将至。
09-28 5857
如何优雅的起个变量名？ 命名神器 CODELF 网址 ： https://unbug.github.io/codelf/ 网站简介：在我们写程序的时候，大部分开发者或多或少遇到过变量命名的烦恼，如果命名不规范，不仅会影响开发的效率，而且对后面维护的同学来说也是一个不小的挑战，因为他要去揣摩你这个变量的含义。总是需要去给各种变量命名。于是各种命名大法都上来了，有拼音的，有首字母缩写的，各种各样。而我们推荐的命名肯定是英文的驼峰命名。首推宝藏网站：CODELF 好东西要一起分享！！！ ...
工程实践：如何给变量取一个好的名字
小猴子的博客
05-19 701
工程实践：如何给变量取一个好的名字 　　在上一篇文章中跟大家分享了关于函数命名的一些实践心得，今天我们继续命名这个话题，来讲一讲如何对变量命名。 　　以下是本文的目录大纲： 　　一. 变量命名风格 　　二. 变量命名最高境界 　　三. 变量命名最佳实践 　　若有不正之处请多多谅解，并欢迎批评指正。 　　请尊重作者劳动成果，转载请标明原文链接： 　https://www.cnblogs.com/dolphin0520/p/10639167.html 一.变量命名风格 　　变量...
关于起变量名的一点看法
我有明珠一颗的博客
04-12 339
之前分享会上，一位同事谈到起变量名的问题： 第一☝️要顾名思义，不怕你写得长一点（甚至可以用好几个单词连起来来表达词意），就怕你简简单单乱起个名字，不管是自己日后来看还是别人来维护的时候都一脸懵逼。 第二☝️请参照上一点 当时只是关注了一下，日后再给变量/方法/类/项目 起名的时候就格外注意了些，关于变量名引发的问题，我直到近日才深刻体会到。 之前要维护一段前端代码，...
变量命名总结
kaolagirl的博客
09-24 5615
我在编程的时候发现自己对变量的命名比较混乱，有时候命名无厘头也没有统一的规则，根本没有辨识性。故今天来对变量命名的技巧和原则做个总结，一是分享同大家学习，二也是勉励自己，编程路漫漫，定不是一朝促成，需要长久坚持与学习！ 一. 命名法则 目前，业界共有四种命名法则：驼峰命名法、匈牙利命名法、帕斯卡命名法和下划线命名法，其中前三种是较为流行的命名法。 1. 驼峰命名法 命名法则：是指第一个单词小写·，从第二个单词开始每个单词首字母大写。 下面是驼峰命名法来命名的变量和函数的，如下： studengName
pycharm 如何快速自动写局部变量名
最新发布
07-21
<think>我们正在讨论PyCharm中快速生成局部变量名的技巧。根据用户的问题，他希望在PyCharm中能够快速生成局部变量名，即通过某种快捷方式或自动补全功能来创建局部变量。 在PyCharm中，当我们输入一个表达式，然后希望将这个表达式的结果赋值给一个局部变量时，可以使用一个叫做“提取变量”的重构功能（Refactor -> Extract -> Variable），或者使用快捷键（在Windows/Linux上是Ctrl+Alt+V，在Mac上是Cmd+Alt+V）。这个操作会弹出一个对话框，让你输入变量名，然后自动生成赋值语句，并将原来的表达式替换为这个变量。 此外，PyCharm还有一个功能叫做“后缀补全”（Postfix Completion）。例如，你可以先输入表达式，然后输入`.var`，再按Tab键，PyCharm就会自动将这个表达式赋值给一个变量，并为你生成一个默认的变量名（你可以立即修改这个变量名）。这个默认变量名通常是根据表达式类型或内容自动生成的。 例如： 1. 你输入`42.var`然后按Tab，它会变成`i = 42`（因为42是整数，所以默认变量名为i）。 2. 你输入`"hello".var`然后按Tab，它会变成`s = "hello"`（s表示字符串）。 另外，如果你已经写了一个表达式，然后将光标放在表达式上，按Alt+Enter（或者使用灯泡图标），在弹出的菜单中选择“Extract variable”，也可以达到同样的效果。 需要注意的是，后缀补全功能需要先输入表达式，然后输入一个点，再输入补全模板的缩写（如`var`），最后按Tab键。而使用快捷键则是先选中表达式（或者光标在表达式上），然后按快捷键（Ctrl+Alt+V或Cmd+Alt+V）来提取变量。 下面我们用一个简单的例子来说明： 假设我们在函数中写了一个表达式：`3.14 * 5 * 5`，然后我们想把这个表达式的结果赋值给一个变量（比如area）。我们可以这样做： 1. 选中整个表达式`3.14*5*5`。 2. 按Ctrl+Alt+V（Windows/Linux）或Cmd+Alt+V（Mac），然后输入变量名area，按回车。这样就会生成`area = 3.14 * 5 * 5`。 或者使用后缀补全： 1. 输入`3.14*5*5.var`（注意：在表达式后面加上`.var`）。 2. 按Tab键，它会自动生成类似`v = 3.14 * 5 * 5`，然后你可以马上修改变量名v为area。 另外，PyCharm会根据表达式的类型来建议变量名。例如，如果表达式返回一个字符串，它可能会建议使用`s`或者`str`之类的名字，但通常我们更希望有意义的变量名，所以生成后立即修改是一个好习惯。 除了`.var`，PyCharm还有其他后缀补全，比如`.for`（生成for循环）、`.if`（生成if语句）等。 总结一下，快速生成局部变量名的方法主要有两种： 1. 使用提取变量的重构快捷键：Ctrl+Alt+V（Windows/Linux）或Cmd+Alt+V（Mac）。 2. 使用后缀补全：在表达式后输入`.var`然后按Tab。 下面我们通过一个简单的代码示例来展示： ```python # 假设我们有一个表达式，我们想将其赋值给一个变量 # 方法1：使用快捷键 # 首先输入表达式：3.14 * 5 * 5 # 然后选中表达式，按Ctrl+Alt+V，输入变量名area，回车 # 方法2：使用后缀补全 # 输入：3.14*5*5.var 然后按Tab，然后修改变量名为area ``` 注意：后缀补全的模板可以在PyCharm的设置中查看和自定义。打开设置（Settings），然后进入Editor -> General -> Postfix Completion，这里可以看到所有可用的后缀补全模板，包括`var`。 另外，有时候我们可能希望PyCharm能够自动建议变量名。在编写代码时，当我们输入赋值语句的左边部分，PyCharm的代码补全功能会提供一些建议，但通常不会自动生成变量名。不过，我们可以利用后缀补全或者重构功能来快速生成。 最后，需要说明的是，这些功能在PyCharm的Professional（专业版）和Community（社区版）中都是可用的。 §§相关问题§§ 1. 如何在PyCharm中自定义后缀补全模板？ 2. 除了提取变量，PyCharm还有哪些常用的重构技巧？ 3. 如何修改PyCharm的快捷键设置以适应个人习惯？</think>### PyCharm 快速生成局部变量名的技巧 在 PyCharm 中，可以通过以下方法快速生成局部变量名： #### 1. **使用后缀补全 (Postfix Completion)** - 输入表达式后添加 `.var` 后缀，按 `Tab` 自动生成变量 - 示例： ```python 42.var # 按 Tab → 生成 i = 42 "text".var # 按 Tab → 生成 s = "text" [1,2].var # 按 Tab → 生成 lst = [1,2] ``` - **特点**：自动推断变量类型并生成默认名称 #### 2. **重构提取变量 (Refactor → Extract Variable)** 1. 选中表达式 2. 快捷键： - Windows/Linux: `Ctrl + Alt + V` - macOS: `⌘ + ⌥ + V` 3. 输入自定义变量名 - **适用场景**：复杂表达式或需要自定义变量名时 #### 3. **自动补全变量声明** - 输入表达式后按 `Alt + Enter` → 选择 `Introduce variable` - 自动生成带类型注解的变量（需开启类型提示） #### 4. **模板补全 (Live Templates)** 1. 自定义模板：`Settings → Editor → Live Templates` 2. 添加模板： ```text Abbreviation: var Template text: $EXPR$ = $END$ ``` 3. 使用：输入 `var` → 按 `Tab` 生成变量结构 #### 5. **智能类型推断** - 输入等号右侧表达式时，PyCharm 会： 1. 自动提示可能的变量名（基于上下文） 2. 按 `Ctrl + Space` 显示命名建议 3. 支持驼峰式/下划线命名风格自动转换 > **最佳实践**： > - 简单表达式 → 使用 `.var` 后缀补全 > - 复杂逻辑 → 用 `Ctrl+Alt+V` 重构提取 > - 团队规范 → 配置统一的 `Live Templates` > - 类型安全 → 开启 `Type hints` (Python 3.6+) ```python # 示例：快速生成带类型注解的变量 def calculate(): # 输入 (5+3)*2.var → 自动生成 result = (5 + 3) * 2 # 变量名和类型自动推断 return result ```
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值