规范写代码

怎么样的代码才算是好代码

1.好的代码具备六个特点如下：

1.1 使用空行来分割逻辑
1.2 使用注释和花括号
1.3 不用的代码和引用删除
1.4 不要用中文拼音做变量名
1.5 可用，清晰优雅，高效
1.6 写出来的代码不单自己能看懂，也让所有人都能看懂

1.1.1

一般代码超过30行左右，就要考虑，要不要把这些代码封装到一个方法中去。但是即使把这一大段代码扔到一个方法中去，在主函数里调用这个方法，也不能保证以后不会修改这个方法了。所以为了自己和他人，还是有必要对比较长的代码做一些处理。
一般即使是一个方法里面的代码，逻辑也是可以分成一小块一小块的，这个时候我们在这些逻辑中间加上空行，就能告诉别人，我这个代码这里，两个空行中间的代码关联比较大。

1.2.1

更新代码的注释，敲完代码后随手加上的简短的几个注释，会提高看代码的效率好多倍。在看你写的代码时，不必每行每字的看过去，先知道你写这段代码的用途在哪，再去看你的代码，想必事半功倍。

1.3.1

我们写代码时，需要修改代码时经常注释之前的代码，然后把自己的代码加上去。但是又不确定自己的代码100%正确，不敢删掉注释的代码，因为可能还会换为原来的代码。
这样导致的后果是以后如果没有看出注释代码的问题，反而觉得很有道理的话，真的会将你的代码重新用注释代码换回来。
我们写代码要相信自己，该删的时候就要删掉。要学会使用SVN进行版本控制。即使当前版本删掉了，回滚到之前版本依然能够找回来。大可不必担心真的会删掉了，这样万一有什么变故，也还是能够找回来的。
我们也会经常注意到编辑器行首有很多黄色的感叹号warning提示。虽然不影响程序正常运行，但是看着就是有点不雅观，而且过多没有使用的引用，或者外部包，框架，库等等也会拖慢程序的运行速度。删掉这些无用的东西既能优化我们的视觉感受，还能减少不易察觉的隐患。

1.4.1

在项目中，最好不要用中文拼音来作为变量名，类名。使用有意义的英文作为变量名更有利于沟通，和外国人沟通方便，和中国人沟通也方便。曾经看到有人设计数据库，字段名全部使用中文拼音缩写，令人费解，而且非常别扭，大概只有自己能看懂吧。
英文变量名也不要用a，b，c，d作为变量名，使用有意义的单词全称一眼就知道这个变量，这个类是做什么用的。

1.5.1

要做到这三点，首先要明确需求，考虑全面一点，从正确性，边界值，反例三个角度去思考问题.
其次，需要先做一个Demo，用于双方进一步确认需求。没有Demo，双方都不是很确定对方有没有get到我的意思。有了Demo，绝大部分需求都可以确定下来了。一个粗糙的成品好过一个精美的半成品。不要过早优化，先把粗糙的成品做出来，后续慢慢优化。
最后，具体到代码，很多时候都需要调试代码，不要一上来就断点调试，先看一遍代码，检查代码逻辑，理一理思路，然后采用二分法设置断点输出日志，快速定位问题代码。优化时，确定一个优化的基准，优化之后有对比，用数据来告诉别人优化的效果。

1.6.1

如何判定你写的代码是一段好的代码，就是让大家来评判，你写的代码不单你自己能看懂，也让大家也都能看懂，让大家觉得你的代码写的漂亮，无绕城拐弯的感觉，接手你代码的码农，没有挠头的想法。

总结：

多写写代码，可以去背一些经常用到的代码，写好代码可以多让他人来给你批评。