代码简洁之道学习笔记

代码简洁之道

命名：
1、类、函数命名应该有规范性，要尽量做到名副其实。
2、使用可读的名称。
3、使用可搜索的名称。

函数：
1、函数要尽量的短（不超过20行）。
2、一个函数尽量做到只做一件事情。
3、函数编写要有规则：自上而下读代码，相同功能的不同函数要尽量靠近，并且调用者要在被调用者的上面。
4、函数参数：最理想是零参数，其次是单参数，双参数。有足够特殊理由才能使用更多参数（三个以上，三为众，考虑封装类）。
5、有入参尽量保证有返回值（事件除外）。
6、先写try...catch...finally
7、尽量避免返回NUll值，对于调用函数来说，需要做N次判空。
8、尽量避免传入NUll值。
9、拒绝函数有很深的缩进（少写套娃if...else...for等等）。

注释：
1、尽量不写注释（当你的命名足够的可读，那么注释就是累赘，函数变更的同时，注释的更新不一定跟得上，后期就是错误注释）。
2、对有特殊意图的地方进行注释。
3、对有特殊逻辑算法的地方进行注释。
4、做警示性注释。
5、不用的代码不能直接注释不用，应该删除。
6、公用API进行注释说明。

格式：
1、源代码大小：一个好的项目每个文件的大小，绝大多数源文件在200行左右，少数源文件在200-500行，拒绝500行以上源文件。
2、垂直方向上的靠近（调用和被调用应该尽量靠