你是否也被类似的问题困扰过?
实在,我在一开始写代码的时候也为命名变量烦恼过。后来看了许多其他人的项目,请教了前辈的履历,逐步也摸索出了变量命名方法和技巧,在此分享给大家,希望能帮到有类似迷惑的朋友。
关于变量命名,在此分享4点建议:

你可以回顾一下,你现在常用的那几个变量名称,它们中是不是有很大一部分最早是涌如今别人的代码里?
必须承认,你所写的代码很多时候并不那么分外。可能已经有无数古人碰着过相同需求,编写过相似代码。多看一些其他人的代码,你可以从中得到启示,为你未来构写代码、命名变量的时候供应灵感。
二、多读书籍编程是一种措辞,措辞都是后天习得的。作为编程措辞能力的一部分,变量命名也可以通过学习习得。除了上述向别人的代码学习外,还有一个选项便是看英文书本。
至于挑选书目,我建议要有针对性,可以选择一些和你当前业务场景干系的书。通过这些书,你可以在深入理解全体业务逻辑,同时还能在不经意间得到与业务干系的英语词汇,这对你变量起名帮助很大。
三、命名技巧关于变量、类名:
变量名一样平常利用英语,不要用动词,变量名常日建议利用名词,选择的名词须要直接指向该变量的意涵;可以在名词前面添加润色词来区分相似变量,润色词可以是形容词,如sortKey中的sort,也可以是指向更细节的名词,如DataFrame中的Data;如果该变量是根本数据类型,则常日利用名词的单数型式,如果该变量是诸如Array、List、Set这样的数据凑集,则常日利用名词的复数形式作为变量名;类名的命名技巧和变量基本同等,不过类名一样平常不该用复数。关于函数名和方法名:
函数名和方法名的命名逻辑就比较多样了,这里的技巧分享仅作为抛砖引玉,欢迎补充:
方法命名的核心是动词:很多方法用纯动词来表达,如:concat、match等;有些方法名会利用动宾词组:即“动词+浸染工具名词”的形式。值得一提的是,这里的名词在逻辑上也每每可以是方法后面的参数,如:hasNext、trimEnd,这里的Next和End逻辑上也可以是has和trim的参数;活用介词:介词是英语的一大特色,在我们给变量起名的时候也扮演了主要的角色,大量地涌如今方法名中,如:startsWith、charAt等;有些方法因此动名词的形式涌现:通过动词向'er'、'ing'、'ed'的变形来命名方法。这类方法名的一大特点是,指向的结果每每是一个工具实例,常见的如constructor、cheching等;末了一种方法名,便是纯名词的形式:这种方法常日是输出和获取该工具中某个特定的属性或者变量,这种命名办法实质上便是命名变量,可以参考上文对变量的命名,如:keys、items等。其它技巧
闇练利用局部变量和浸染域:有时候同一个变量名会在多处用到,且指向的含义不同。这时候,闇练节制局部变量和浸染域就非常必要了,这让这些附近观点的变量有了利用同一个变量名的可能性,且不会相互影响。常见的例子有for循环中的变量i,便是利用了局部变量和浸染域的特性。不过这个方法须要对该措辞有相称深刻的理解,否则随意马虎涌现变量覆盖。活用匿名函数:匿名函数也是一个减少变量命名的神器,如果能闇练节制匿名函数的利用,常日可以减少10%旁边的变量命名事情。但凡事皆有利弊,匿名函数的缺陷是多人开拓和掩护时会造成理解上的难度。定期检讨僵尸代码:可以有效地帮助你清理变量冗余,为变量起名供应更多余地。分享了这么多干货,看到这里的你,难道不点个赞吗~
四. Github项目分享:
末了,我在这里给大家总结了一些和变量命名有关的Github上的高分项目,大家可以依此学习变量命名技巧:
1. codelf
url: https://github.com/unbug/codelfstar: 13000fork: 968watch: 257这是一个变量命名工具。打算机科学中最困难的两件事:缓存故障和命名。这个工具支持直接搜索中文,当您检索中文时,Codelf 会直接翻译单词并找到单词的同义词。然后搜索Github、Bitbucket、Google Code等开源项目的源代码匹配与这些词干系的变量名和函数名。
在线网址->https://unbug.github.io/codelf/
2. clean-code-php
url: https://github.com/jupeter/clean-code-phpstar: 11000fork: 2800watch: 461PHP代码的整洁之道,整理了一系列整洁代码实操。小到变量细到 SOLID 都有阅读,中文译版->https://github.com/php-cpm/clean-code-php
3. one-python-craftsmanurl: https://github.com/piglei/one-python-craftsmanstar: 5000fork: 823watch: 190
这个项目是针对Python的开拓规范。精良的 Python 代码由无数精良的细节组成。这个项目详细的阐明 Python 那些看似大略的细节,如何利用非常,如何命名变量,如何编写条件分支等,这些看似大略实在也可能是最难的地方。本项目作者是资深 Python 开拓,内容靠近实际事情和业务场景,我相信仔细学习这个项目,你的编码能力会大大提高,帮助你帮助你 Python 更高更远的发展道路。
与变量命名干系的部分,可以直接点这里->https://www.zlovezl.cn/book/ch01_variables.html
以下是我之前分享的有关写代码的利用技巧,有须要的同学可以直接点击下方链接获取:
【推举阅读】程序员如何写出一手优雅的代码?18条规则你必须要知道
「LSTM文本天生器」动手写一个自动天生文章的AI,附完全代码
结束语我是@老K玩代码,专注于编程开拓的履历总结和项目分享,如果你对编程感兴趣,可以关注我。
有其它开拓干系的问题,欢迎随时私信我。