变量、函数、类的命名规则

所属分类: 网络编程 / 相关技巧 阅读数: 1788
收藏 0 赞 0 分享
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这类带有动作的词语;方法名,尽量的能够体现出这个方法的动作,所以最好使用动词,或者动词短语,例如:postMail、deletePage,等等。

9、每个概念对应一个词:

  给每个抽象概念选一个词并且一以惯之,例如使用get、方法,getMsg()、getUsername()、getUerId()等等。

10、不要使用双关语:

  避免同一个单词用于不同的目的,比如说add这个就不是很好,可以使用append这类词语替换他。

11、添加语境:

  就是给一些变量或者函数一些语境,比如说:这段变量,firstName、lastName、street、state,这些东西看起来我们都明白,但是我们都不知道他是描述什么的,如果加上address,改为;addressFirstName、addressLastName、addressStreet、addressState,这样的话就明朗很多了。

  大家在对变量、函数、类命名的时候一定不要害怕他很长,只要能够读懂就好,当然如果短能够描述的清楚的话,还是必须得选择短的,我是想说如果想描述清楚,不要害怕变量、函数、类的命名太长。
更多精彩内容其他人还在看

firefox 扩展开发技巧

firefox 扩展开发
收藏 0 赞 0 分享

php asp.net 比较 [推荐]

如今当提到 Web 开发时,您有许多选择。这些方法中许多都涉及到预处理 - 即,利用特定的标记将代码嵌入到 HTML 页面中
收藏 0 赞 0 分享

UTF-8 BOM 可能导致样式错乱的解决方法

utf-8 是一种在web应用中经常使用的一种 unicode 字符的编码方式,使用 utf-8 的好处在于它是一种变长的编码方式,对于 ANSII 码编码长度为1个字节,这样的话在传输大量 ASCII 字符集的网页时,可以大量节约网络带宽。
收藏 0 赞 0 分享

Web 开发常用工具 大家自己查找下载

看到了Web通信分析工具 这篇文章,除了burpsuite其他我日常都经常使用。于似乎我整理了一下我自己用的其他的WEB开发工具。
收藏 0 赞 0 分享

遇到不能复制的网站怎么办?

有时我们看到喜欢的网页内容时定会产生复制下来为我所用的冲动,不过当你点击鼠标时它却没有任何反应,选择的内容没有任何变化,不禁有点扫兴。不要紧,办法总比困难多!
收藏 0 赞 0 分享

URL 长度有限制吗?

众所周知, 传递小量参数(在没有其他原因,例如隐藏参数值的情况下)推荐使用GET方法,传递大量参数推荐使用POST方法。原因是什么呢?
收藏 0 赞 0 分享

声音验证码制作方法

收听验证码已经比较普遍了,使用户看不清楚的情况下可以通过耳朵来收听验证码,但网上搜了很久没看到有具体的制作方法,自己想了想,还是按自己的方法来实现了,呵呵。
收藏 0 赞 0 分享

防范SQL注入式攻击

SQL注入式攻击是利用是指利用设计上的漏洞,在目标服务器上运行Sql命令以及进行其他方式的攻击动态生成Sql命令时没有对用户输入的数据进行验证是Sql注入攻击得逞的主要原因。
收藏 0 赞 0 分享

Web 设计与开发者必须知道的 15 个站点

今天读到一篇文章,介绍了15个对 Web 设计与开发师极端有用的站点,里面有不少也是我们一直在使用的,也许对很多人都有用,翻译出来以饷同仁。
收藏 0 赞 0 分享

十分钟内学会 避免用户刷新导致重复POST提交

在Web应用中,采用POST提交信息是非常常见的,然而如果目标页面打开得太慢,用户就可能会刷新页面,这时候之前已经提交过的信息就会被重复提交。
收藏 0 赞 0 分享
查看更多