美文网首页
有意义的命名

有意义的命名

作者: 前进中的奋斗猿 | 来源:发表于2018-07-23 00:53 被阅读0次

前言

    在开发过程中,给变量以及方法提供一个有意义的命名至关重要。有意义的命名对代码可读性的提升有很大帮助。一个项目开发完后甚至在开发过程中,有可能由于项目的部分参与者工作变动或者项目人手不够导致有新的开发者参与进来,这些新加入的开发者开始的时候并不熟悉整个项目,在他们熟悉代码的过程中有意义的命名可以极大的提升项目的开发效率,而没有意义的命名会严重延缓项目进度。

 那么,如何实现有意义的命名呢?

有意义的命名

在给变量或者函数命名的时候,名字应该能够准确表达真实意思,比如我们要声明一个变量来表示时间,

    int t;

    这里t并不能清晰的表明是时间,如果我们想要增强代码的可读性,我们可能就需要增加注释说明了。在代码中适当的注释是必要的,但是有时候我们完全可以避免不必要的注释,我们可以使用如下声明避免增加注释而能准确表示变量的意思,

    int time;

    变量名长一点没有关系,毕竟变量名的长短又不会影响内存的占用。

    在命名的时候,还是要努力提高即几的知识水平(smile),确保用英文单词的时候词要大意。单词用错很有可能不能快速且正确的传递代码的意思。

    我们应该避免一些容易引起误导的命名,比如我们现在要声明一个用于存储一组电话号码的变量, 可能我们就会很轻易的命名为phoneNoList。除非我们真的将变量声明为List类型,否则我们还是不要如此命名,因为这样命名会容易让其他的开发者认为是List类型,但实际操作的时候却不是按照List类型来操作从而造成困惑。另外我们有时候要区分单复数,比如我们用一个变量来记录众多客户的信息,应该用

    List customerInfos;

    来声明,而不是用

    List customerInfo;

    我们在命名的时候,在必要的时候尽量添加一些有意义的语境,比如在存储外国人的名字时,我们不要用诸如name1,name2等这样带编号的名字来命名,我们应该使用如firstName,lastName等这样带语境的名字来命名。但是忌讳添加没有意义的语境,比如现在开发一个“拯救地球”(Save The Earth)的应用,我们不能再所有名字前面都加上STE这样的语境,如果真这么做的话,用IDE开发的时候指定会崩溃的

易于检索的命名

    在命名函数或变量的时候,尽量不要用很常用的名字来命名。在一个大的项目中,如果用太常用的名字来命名的话,在检索变量或函数的时候很有可能给我们展示出一堆信息,这样会导致我们需要花费一定的时间去筛选出我们需要的信息。在用IDE编码的时候也能够快速给出有效的提示。

相关文章

  • Clean Code Notes(代码规范)

    [TOC] Clean Code Notes 1_命名 1.1_命名要点 有意义的命名 有意义的区分 有意义命名部...

  • java编码规范(更新中)

    编码规范 命名规范 任何包名、类名、方法名、属性等都要使用有意义的单词,有意义的命名;命名不在于长,而在于解释 包...

  • 有意义的命名

    前言 在开发过程中,给变量以及方法提供一个有意义的命名至关重要。有意义的命名对代码可读性的提升有很大帮助。一个项目...

  • 有意义的命名

    名副其实 变量名应该告诉你:他为什么会存在,他做什么事,他应该怎么用 如果名称需要注释来补充,那就不算名副其实 p...

  • 有意义的命名

    在编程过程中,命名随处可见。我们在编程过程中,应使命名名副其实。这件事很重要也很严肃,选个好的名字要花很多时间,但...

  • 有意义的命名

    当发现更合理的命名时,可以随时替换。 变量、函数和类要依义命名,好的命名可以不用补充注释就知道其用途。好命名能有效...

  • 有意义的命名

    有意义的命名 我们给变量,函数,参数,类和封包命名,我们给源代码及源代码所在目录命名,既然有这么多命名要做,不妨做...

  • 有意义的命名

    名副其实 对于变量、函数或类的名称应该已经回答了如下几个问题,它为什么存在、它做什么事、应该怎么用,无需注释即可明...

  • 有意义的命名

    关于命名 开发过程中的命名无处不在:变量,函数,参数,类和包 命名技巧 名副其实 选个好名字要花时间,但省下来的时...

  • 有意义的命名

    变量、函数和类的名称应该已经答复了所有的大问题。它告诉你,它为什么存在,它会做什么事,应该怎么用。如果名称需要注释...

网友评论

      本文标题:有意义的命名

      本文链接:https://www.haomeiwen.com/subject/jzirmftx.html