标签：注释 函数 记录 0823 代码 单元测试 --- 编写 整洁

----规范-----------
读书笔记：

第一章 整洁代码
1，整洁代码力求集中，每个函数、每个类和每个模块都全神贯注于一件事。
2，整洁代码简单直接，从不隐藏设计者的意图。
3，整洁代码应当有单元测试和验收测试。它使用有意义的命名，代码通过其字面表达含义。
4，消除重复代码，提高代码表达力。
5，时时保持代码整洁。
第二章 有意义的命名
1，使用体现本意的命名能让人更容易理解和修改代码。
2，编程本来就是一种社会活动。
3，尽力写出易于理解的代码
第三章 函数
1，一个函数应该只做一件事（高内聚），无副作用。
2，自顶向下阅读代码，如同是在阅读报刊文章。
3，长而具有描述性的函数名称，好过描述性的长注释。
4，使用异常代替返回错误码，错误处理代码就能从主路径代码中分离出来得到简化。
5，写代码很像是写文章。先想怎么写就怎么写，然后再打磨：分解函数、修改名称、消除重复。
6，编程其实是一门语言设计艺术，大师级程序员把程序系统当做故事来讲。使用准确、清晰、富有表达力的代码来帮助你讲故事。
第四章 注释
1，别给糟糕的代码加注释----重写吧。
2，把力气花在写清楚明白的代码上，直接保证无需编写注释。
第五章 格式
1，代码格式很重要。代码格式关乎沟通，而沟通是专业开发者的头等大事。
2，向报纸格式学习代码编写。
第六章 对象和数据结构
1，对象把数据隐藏于抽象之后，只提供操作数据的函数。数据结构暴露其数据，没有提供有意义的函数。
2，The Law of Demeter：模块不应去了解它所操作的对象内部细节。
第七章 错误处理
1, 使用异常而非返回错误码。
2, try-catch-finally, log出错信息。
3, 不要返回null，不要传递null。NULL Object模式, 例：Collections.emptyList();
第十章 类
1，自顶向下原则：让程序读起来就像是一篇报纸文章。
2，method可以是protected，以便于单元测试。
3，SRP：类或模块应有且仅有一个加以修改的原因。类名应准确描述其职责。高内聚。
4，开放闭合原则、依赖倒置原则。
5，变量名、方法名、类名都是给代码添加注释的一种手段。
第十二章 迭代前进
1，紧耦合的代码难以编写单元测试。
2，单元测试消除了对清理代码会破坏代码的恐惧。
3，写出自己能理解的代码很容易，软件项目的主要成本在于长期维护。
4，代码应当清晰表达其作者的意图；测试代码可以通过实例起到文档作用。
第十四章 逐步改进
1，编程是一种技艺。要编写整洁代码，必须先容忍脏代码，然后清理！
2，写出好文章就是一个逐步改进的过程。
----
一个优秀的程序员，在接到一个要编写“毁灭地球”的任务的时候，他不会简单的写一个destroyEarth()的方法；而是会写一个destroyPlanet()的方法，将earth作为一个参数传进去。
-------------------

标签：注释,函数,记录,0823,代码,单元测试,---,编写,整洁
来源： https://www.cnblogs.com/Insist-Y/p/16615793.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。