脚本宝典收集整理的这篇文章主要介绍了变量、函数、类的命名规则,脚本宝典觉得挺不错的,现在分享给大家,也给大家做个参考。
1、命名要名副其实:
命名的时候一定要考虑他的显示意义和语境,不要认为把时间花费在变量的命名上很浪费。当然如果你程序很短的话,就不需要考虑那么多了,埋头就写代码。如果你的项目大,而且文件多的情况下,最好就是要花费时间在命名上,因为你的代码不仅仅只是你一个人看的。
2、避免误导:
也就是说不要把其他平台的关键字拿来命名,比如说我使用javascript语言,而我设计了一个变量为int,这让人会很头疼,为什么要一个int变量呢,难道这段代码是C++。这样就会让人产生误导。如果你想一个
整型变量你可以这样,
VAR intNumber;
3、做有意义的区分:
variable:
永远不要拿来作为变量的名称、table永远不要拿来作为表的名称,
等等。不要使用相似的命名,必须做有意义的区分,比如说:有一组变量,有些童鞋会这样命名,a1、a2、a3
...,而如果我们根据他们的作用来命名效果会好很多。
4、使用容易读懂的名称:
最好就是使用一段英文,
或者英文短语,切莫一些中文,一些英文混合,或者单纯的中文。比如:我们想写一个函数作用是,切换语言:qieHuanYuYan,这样的话大家读起来就会一个个的去拼写,而且最后还不一定能够拼写成功,如果
改为:changeLanguage效果会好很多。
5、使用可搜索的名称:
我建议大家在使用
阿拉伯数字的时候,最好能在代码的最
开始,使用大写加下划线定义。比如说50度是一个人体能够承受的
电力最大福特越界值,那么我们可以命名为:
PEOPLE_MAX_VOLTA;当然我英语能力有点不好,但是基本是这个原理。如果单纯的使用50的话,会让人不
知道这个
是什么标准,如果变成变量就容易阅读。而且大家最好不要使用单个的英文字母,因为那样会造成相当大的麻烦,不仅仅是搜索,而且也难易理解。
6、避免使用编码:
不要使用一些前缀命名,比如说加一个m_之类的,这样虽然可以多次命名,但是会让人难以读懂。
7、避免思维映射:
避免单个名称,
明确才是王道,不要以为你的单个名称
别人看不懂,你就很牛逼。如果代码看起来像看小说一样,那才叫牛逼。
8、类名、方法名
类名应当是名词、或者名词短语。例如:Customer、WikiPage,避免使
用Maneger、Perocessor这类带有动作的词语;方法名,尽量的能够体现出这个方法的动作,所以最好使用动词,或者动词短语,例如:postM
ail、deletePage,等等。
9、每个概念对应一个词: 给每个抽象概念选一个词并且一以惯之,例如使用get、方法,getMsg()、getUsern
ame()、getUerId()等等。
10、不要使用双关语:
避免同一个单词用于不同的目的,比如说add这个就不是很好,可以使用append这类词语替换他。
11、添加语境:
就是给一些变量或者函数一些语境,比如说:这段变量,
FirstName、lastName、street、
state,这些东西看起来我们都明白,但是我们都不知道他是描述什么的,如果加上address,改为;addressFirstName、addressLastName、addressStreet、addressState,这样的话就明朗很多了。
大家在对变量、函数、类命名的时候一定不要害怕他很长,只要能够读懂就好,当然如果短能够描述的清楚的话,还是必须得选择短的,我是想说如果想描述清楚,不要害怕变量、函数、类的命名太长。
脚本宝典总结
以上是脚本宝典为你收集整理的变量、函数、类的命名规则全部内容,希望文章能够帮你解决变量、函数、类的命名规则所遇到的问题。
如果觉得脚本宝典网站内容还不错,欢迎将脚本宝典推荐好友。
本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。