`
朱秋旭
  • 浏览: 230672 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

重构代码之1-命名

阅读更多

对于一个像我这样严肃的程序员来讲酷,个人觉得起变量名就想给自己的孩子起名一样重要,如果你有N胞胎长得都像String一样,你如何区分他们,显然用1,2,3,4...或者a,b,c,d的方式是根本无法做到好的区分的,那我们应该怎么做? 这就是我想说的为程序变量起有意义的名字很重要。

1. 使用可以见名知意的名称作为变量名称:

举个例子:

 如果你的变量名还需要注释,何不把变量名起的见名知其意呢?

试想下面的两段代码你更喜欢阅读哪一个呢?



 

 是不是第二段代码看过之后很清晰啊,其实很明显第二段代码只是仅仅是改变了变量名,让每个变量名都变得有意义,所以想一个有意义的变量名,方法名,在未来会节省我们很多的维护成本。但是请大家不要轻易的使用一些只有自己能理解的简称来命名,鼓励变量名可读,使用完整单词,这样可以降低沟通成本。

 

提到有意义的变量名必须多啰嗦一句就是不要用accoountList这种变量名,除非返回值真的是List类型,也不用使用o,l 这样的变量,因为他们真的很像0,1数字。

 

2  对于函数的参数我们一样要进行有意义的区分:

现在思考一下你是否曾写过这样的代码

public static void copyChars(char[] c1, char[] c2){

    for(int i = 0; i < a1.length; i++){

       a2[i] = a1[i];

    }

}

如果source, destination有没有清晰很多,

让我们来参观一下JDK是如何为参数命名的:



 
3  使用常量,变量代替一些标志量,计算变量:

比如这样的命名

 会不会比你写flag,写一些数字去控制删除次数,睡眠时间更加友好,也更加容易维护呢?如果下次老大说修改一下睡眠时间和修改次数,直接改常量就好了不用满屏幕的ctrl+f了。

 

4  如果你不能发明出更好的就使用匈牙利命名法(驼峰命名法)吧。对于单变量,作用范围小,简单的循环计数器这样的变量就是用i,j,k吧,不要发明出什么a,b,c,x,y,z之类的东西,因为i,j,k使用程序员都懂得的语言啊。

 

5  类名用名词,方法名用动词。千万不要同一个概念中出现不同的词汇,比如说大家都是controller,那就都是XXXController就好了,干嘛突然搞出个什么XXXManager呢? 再比如,连接字符串就用append呗,插入就用insert呗,干嘛要搞得满屏幕都是叫add的方法呢?相同的概念确不同的命名会很容易让人产生疑问。

 

6  如果你开发的是专业细分领域的东西,那就用这个领域的专业词汇去命名,这样命名才更有意思,更规范,在该领域中也更容易被理解。

 

如果我提到的问题在你的程序中出现,那么就请修改一下吧,让你的代码变得干净简洁。

以上问题属于个人感受的一个表达,如果有一些不妥的地方欢迎大家留言,共同探讨,共同学习。

  • 大小: 16.6 KB
  • 大小: 7 KB
  • 大小: 9.2 KB
  • 大小: 5.2 KB
  • 大小: 14.6 KB
1
0
分享到:
评论

相关推荐

    重构源代码C1-c++版本

    重构时需考虑C++的命名空间、类、对象、模板、继承、多态等特性。 2. **函数提取**:当发现一个函数或方法过长,或者包含了多个职责时,我们可以将其拆分为更小的函数。这样可以使代码更易读,每个函数都有明确的...

    .java代码重构

    - **保持重构的节奏**:定期进行小规模的重构,避免积攒大量待重构代码。 - **沟通与文档**:让团队成员了解重构计划,更新相关文档,避免引起混乱。 - **持续集成**:结合CI/CD流程,确保重构不会影响到其他功能...

    重构-改善既有代码的设计

    重构是软件开发过程中一个至关重要的环节,它旨在不改变代码外在行为的前提下,改进代码结构,使之更易理解和修改。此书深入浅出地介绍了重构的概念、原则和实践方法,对于任何Java开发者来说,都是提升编码技艺的...

    代码之美---精选版

    《代码之美---精选版》是一本深受欢迎的编程技术书籍,它汇集了众多编程实践中的智慧结晶,旨在帮助程序员提升代码质量,实现更优雅、更高效的编程。这本书以高清晰的PDF格式呈现,使得读者在学习过程中能享受到更好...

    重构 改善既有代码的设计 中文高清完整版pdf

    1. **70多种重构案例**:书中提供了超过70种具体的重构案例,每个案例都包括了重构前后的代码对比、实施步骤及注意事项等。 2. **常见重构模式**: - **简化函数**:通过提取函数、分解条件语句等方式简化复杂的...

    一次代码重构之旅-快速读写xml文件工具类封装

    在描述中提到的博客文章“一次代码重构之旅-快速读写xml文件工具类封装”,作者分享了如何通过Java进行XML操作的优化,将原始的XML处理代码整合到一个工具类中,提供简洁易用的API。在阅读该博客文章的过程中,我们...

    代码大全--代码之美

    1. **代码规范**:书中强调了遵循统一的编码风格和命名约定的重要性,这不仅有助于团队协作,还能使代码更易于理解和调试。例如,使用有意义的变量名,遵循缩进规则,以及避免过长的函数和过深的嵌套。 2. **注释与...

    重构改善既有代码的设计第2版.pdf

    1. 重构的定义和重要性:重构是指对既有代码的修改,以提高代码的质量和可维护性。重构的目的在于使代码变得更加简洁、易读和易维护。 2. 重构的原则:包括何谓重构、两顶帽子、为何重构、何时重构、重构的挑战、...

    重构_改善既有代码的设计.pdf

    总之,《重构——改善既有代码的设计》不仅是一本对于Java程序员来说非常重要的参考书,也是所有软件开发人员都应该掌握的关键技能之一。通过不断地练习和实践,开发者可以逐步提升自己的重构能力,从而写出更加高...

    重构java代码简洁之道

    1. **命名规范**:使用有意义的变量、类和方法名,避免使用缩写和模糊的名称,以提高代码可读性。 2. **提取方法**:当一个方法或函数过于复杂时,通过提取出子任务,创建新的方法,让每个方法只做一件事情,遵循...

    java代码重构经验总结

    ### Java代码重构经验总结 在软件开发过程中,代码重构是一项重要的技能,它旨在不改变代码外部行为的前提下,改进其内部结构,从而提升代码质量和可维护性。本文将深入探讨Java代码重构的关键点,涵盖重构原则、...

    重构-改善即有代码的设计

    《重构-改善既有代码的设计》是一本由马丁·福勒(Martin Fowler)撰写的经典IT图书,主要关注软件开发过程中的代码优化与设计提升。这本书深入探讨了如何通过一系列微小而精确的改动,逐步改进代码结构,提高代码...

    代码之美-精选版 [文字版]中文.PDF

    《代码之美-精选版》是一本专注于代码优化的书籍,以中文形式呈现,提供的是文字版而非扫描版,因此读者可以方便地搜索、复制和粘贴其中的内容。这本书旨在帮助开发者提升代码质量,提高程序运行效率,降低维护成本...

    重构-改善既有代码质量

    《重构-改善既有代码质量》一书是Martin Fowler的经典之作,它深入探讨了如何通过重构技术来提升软件的可读性、可维护性和整体质量。重构是一个系统化的过程,旨在改进代码结构,而不改变其外在行为。在这个过程中,...

    看大师如何重构代码(java程序员必看)

    本文将深入探讨《看大师如何重构代码(java程序员必看)》这一主题,解析代码重构的核心概念、实践方法以及其对Java编程的深远影响。 ### 代码重构的概念 代码重构是指在不改变代码外部行为的前提下,对其内部结构...

    一本代码重构的书让代码更简洁

    《重构:改善既有代码的设计》是一本由Martin Fowler所著的经典书籍,专注于讲解如何通过重构技术来提升代码质量,使其更具可读性、可维护性和扩展性。在Java编程领域,重构是提升软件开发效率和降低维护成本的重要...

    重构-改善既有代码的设计(含中文PDF,英文chm)

    《重构:改善既有代码的设计》是一本由Martin Fowler所著的经典软件工程书籍,它深入探讨了如何通过重构技术提升代码质量、可维护性和设计的优雅性。这本书对于开发者来说是不可或缺的参考文献,无论是在团队协作...

Global site tag (gtag.js) - Google Analytics