`
haibin369
  • 浏览: 60100 次
  • 性别: Icon_minigender_1
  • 来自: 深圳
社区版块
存档分类
最新评论

关于代码整洁

阅读更多
  • 整洁的代码只做好一件事!每个类,每个方法都应该专注于一件事。
  • 选个好名字要花时间,但能省下更多的时间。一旦发现有更好的名称,就应该换掉旧的。
  • 如果名称需要注释来补充,那就不算是名副其实。
  • 方法名应该是动词或动词短语。
  • 每个概念对应一个词,避免在多个地方用fetch,retrieve,get等不同单词表示“获得”的意思。
  • 函数或者方法应该在做好并只做一件事的基础上尽量短小。
  • 别害怕长名称,长而具有描述性的名称,要比短而令人费解的名称好。
  • 尽量避免多参数函数或方法。
  • 可以把try/catch代码块的主体抽离出来独立成方法,使之与try/catch隔离,更清晰。
  • 避免重复代码。
  • 不要使用goto语句。
  • 注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败,一旦发现自己需要写注释,应该先想想是否能用代码来表达。
  • 唯一真正准确的信息来源是代码,而不是注释。
  • 不要保留注释掉的代码。
  • 变量应该在类或这方法的顶部声明。
  • 相关方法应该按照调用顺序(或者相关性)放在一起。
  • 隐藏实现并非只是把变量通过getter和setter推向外间,而是暴露抽象接口,以便用户无需了解数据的实现就能操作数据本体。
  • 不要返回null值。
  • 不要在方法中传入null值。
  • 线程应该尽可能的保持独立。
  • 尽量减少源文件中额外的编程语言的数量和范围。
  • 基类不能依赖于派生类。
  • 删除执行不到的代码。
  • 方法名称应该表达其行为。
  • 否定(非)表达式要比肯定表达式难理解一些。
  • 把方法参数按被调用顺序排列。
  • 不要继承常量。
0
0
分享到:
评论
1 楼 ZSYCW 2014-01-11  
很好

相关推荐

    读代码整洁之道幻灯片笔记

    这本书强调了编写可读性好、易于维护的代码的重要性,提出了许多关于代码整洁性的原则和实践方法。以下是对书中核心知识点的详细阐述: 1. **代码就是沟通**:代码不仅是计算机执行的语言,更是开发者之间交流思想...

    代码整洁之道-----读书笔记

    在阅读这本书的过程中,我们可以学到很多关于代码整洁性的关键概念。 1. **命名规范**:书中的一个重要部分强调了有意义的命名对于代码可读性的重要性。好的命名应该简洁明了,能够准确反映变量、函数或类的用途。...

    Study代码整洁Study代码整洁

    综上所述,"Study代码整洁"不仅仅是编写干净的代码,更是关于如何在C#开发中遵循最佳实践,提高代码的可读性、可维护性和团队协作效率。通过学习和应用这些原则,我们可以提升自己的编程技能,为软件项目打造坚实的...

    clean_code(完整版).rar

    “clean_code(完整版).rar”这个压缩包文件包含的是关于代码整洁和良好编程实践的重要资源,主要体现在“clean_code(中文完整版).pdf”这本书籍中。这本书深入探讨了如何通过遵循一系列规则来提高软件的质量,使代码...

    Writing clean code.zip

    书中提供了关于代码整洁性的具体实践建议,如遵循一定的编码风格,保持函数短小精悍等。 6. **单元测试**:单元测试是保证代码质量的重要工具。书中有介绍如何编写有效的单元测试,以及如何利用测试驱动开发(TDD)...

    Web前端:11个让你代码整洁的原则(1)

    标题和描述中提到的知识点是关于Web前端开发中如何保持代码整洁的11个原则,这一部分主要聚焦在HTML和CSS的最佳实践上。下面将详细展开这些原则: ### 一、DOCTYPE的声明 DOCTYPE声明是HTML文档的第一行,用于告诉...

    推荐2_Clean C++(2017)

    整体来看,文件信息表明这是一本关于C++编程的书籍,侧重于清洁代码、可持续软件开发的实践,以及如何利用C++17标准的最佳实践。书籍覆盖了广泛的知识点,包括版权信息、出版流程、编辑团队以及全球分销网络,既是一...

    clean_code(中文完整版)

    《代码整洁之道》是由美国著名软件工程师、软件领域权威作者Robert C. Martin所著。这本书的中文版本由韩大翻译,并由人民邮电出版社在2010年1月首次出版,随后在同年5月进行了第二次印刷。书籍的英文原名是《Clean ...

    编写整洁的PYTHON代码

    以下是一些关于如何编写整洁Python代码的关键知识点: 1. **代码规范与PEP 8**: - PEP 8是Python的官方编码风格指南,它定义了如何格式化代码、命名变量和函数,以及如何注释等。遵循PEP 8可以确保代码的一致性。...

    整齐地

    压缩包子文件“neatly-master”可能是一个项目的源码仓库,根据命名推测,这个项目可能关注于提供一种整洁的PHP开发方式或者是一个关于代码整洁性的示例库。在探索这个项目时,可以学习其代码组织结构、编码习惯以及...

    简单整洁模具工厂网站源代码

    在压缩包中的"说明.txt"文件,很可能是提供给用户关于如何安装、配置和使用这套源代码的详细指导。而"1024"可能是源代码的主文件夹或者一个重要的组件,比如一个示例数据库文件或者预设的图片资源。 在实际使用过程...

    让代码整洁、过程清晰的BASH Shell编程技巧

    在编写BASH Shell脚本时,保持代码整洁和过程清晰至关重要,尤其是在处理大型项目时。以下是一些关于如何实现这一目标的技巧和最佳实践。 首先,关于全局变量的使用,应尽量减少其数量并确保它们是不可变的。全局...

    Delphi 代码格式化工具

    在编写Delphi代码时,保持代码整洁、规范格式化是提高代码可读性和团队协作效率的重要因素。这里提到的"Delphi 代码格式化工具"就是专门针对这一需求设计的实用软件。 该工具可能具备以下功能: 1. 自动缩进:能够...

    《Python整洁编程》

    Python官方推荐了许多良好的编程习惯,其中PEP8(Python Enhancement Proposals 8)是关于代码风格和可读性的指导文档。通过遵循PEP8,开发者可以提高代码的整洁度和可读性,从而使得代码更易于理解和维护。 PEP8...

    java 代码块折叠插件

    Java 代码块折叠插件是一种增强IDE(集成开发环境)功能的工具,它允许程序员更加高效地管理和阅读源代码。在编程过程中,特别是在处理大型项目...此外,良好的代码折叠习惯也有助于保持代码整洁,便于他人理解和维护。

    WindowsVB代码管理工具

    6. **重构支持**:提供代码重构工具,帮助改进代码结构,保持代码整洁。 7. **文档生成**:自动生成代码文档,便于理解和维护。 8. **团队协作**:支持多人协作,通过共享代码库,实现团队间的高效合作。 9. **...

    C语言格式化代码工具(百度百科、知道上复制代码不再烦恼!)

    在编程领域,保持代码整洁和规范是至关重要的。C语言是一种广泛应用的编程语言,它的代码组织和可读性直接影响到程序的维护和团队合作。"C语言格式化代码工具"就是为了帮助开发者解决这个问题,尤其当你从百度百科或...

Global site tag (gtag.js) - Google Analytics