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

所属分类: 网络编程 / 相关技巧 阅读数: 1770
收藏 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,这样的话就明朗很多了。

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

StringBuider 在什么条件下、如何使用效率更高

都说 StringBuilder 在处理字符串拼接上效率要强于 String,但有时候我们的理解可能会存在一定的偏差。今天小编给大家带来一篇教程关于StringBuider 在什么条件下、如何使用效率更高?感兴趣的朋友一起看看吧
收藏 0 赞 0 分享

2020年最火的6种编程语言推荐

当下计算机编程语言总数达到好几万种,但是最流行的编程语言有哪些呢,今天,小编就给大家盘点一下2020年很受欢迎的编程语言,感兴趣的朋友一起看看吧
收藏 0 赞 0 分享

遵守这些原则让你开发效率提高一倍(收藏)

这篇文章主要介绍了遵守这些原则让你开发效率提高一倍,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
收藏 0 赞 0 分享

使用idea 去除 html 代码前的行号和空行的方法详解

这篇文章主要介绍了使用idea 去除 html 代码前的行号和空行,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
收藏 0 赞 0 分享

云开发 VSCode 插件 Cloudbase Toolkit 的正确打开方式及应用场景分析

Tencent CloudBase Toolkit 是云开发的 VS Code(Visual Studio Code)插件。这篇文章主要介绍了云开发 VSCode 插件 Cloudbase Toolkit 的正确打开方式,需要的朋友可以参考下
收藏 0 赞 0 分享

12个Visual Studio调试效率技巧(小结)

这篇文章主要介绍了12个Visual Studio调试效率技巧,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
收藏 0 赞 0 分享

fiddler抓包小技巧之自动保存抓包数据的实现方法分析【可根据需求过滤】

这篇文章主要介绍了fiddler抓包小技巧之自动保存抓包数据的实现方法,较为详细的分析了fiddler自动保存抓包数据及根据需求过滤相关操作技巧,需要的朋友可以参考下
收藏 0 赞 0 分享

解决IDEA中编辑HTML格式文件不自动缩进问题

这篇文章主要介绍了解决IDEA中编辑HTML格式文件不自动缩进问题,本文内容简短,解决方法给大家提出了,需要的朋友可以参考下
收藏 0 赞 0 分享

vsCode中配置setings.json的技巧

本文给大家分享的是一个在vsCode中配置好的setings.json的样例,可以给大家一个参考,有需要的小伙伴可以来看下
收藏 0 赞 0 分享

全网最详细的vscode基础教程

vscode全称为visual studio code,是微软旗下一款非常优秀的跨平台代码编辑软件。vscode 中文版集成了大部分代码编辑的器的优点,集成GIT、代码调试、语法高亮,拥有强大丰富的插件系统
收藏 0 赞 0 分享
查看更多