总结一些写代码的的规范

做了一个长达半年的实验（仍在继续中），最近越来越感觉到已经看不懂原来的代码了，随着实验需求的变化，之前的代码模块之间耦合度太高，新需求往往只能拆解已有的函数后再实现或者干脆使用method+数字的方法进行区分，才初步体会到维护一个长期开发的代码的痛苦，以及跑实验的代码和实际业务要使用的代码还是不一样，于是想总结一些经验以防以后踩坑。。

1. 一定要写注释，而且要用中文写

曾经觉得好的代码不需要注释，好的命名规范和接口设计能够让函数的功能一目了然。
然而当过了个双休日/节/年之后，之前的代码再去看可能就变得不那么明确了。。
用中文更好解释，有时候我自己用英文写的注释自己都懒得看/看不懂。。

2. 实现的工具和做实验是两码事

举个例子，现在要实现一个简单的工具T，它的基本流程是：读取文件(read)→处理文本(process)→输出结果(output)。
做实验时，可能会多次读取同个文件，那么当实现完工具T时，假设要使用这个工具进行10次循环，那么在一次试验中就要读取同个文件的内容10次，后9次的读取操作就重复了，假如这里读取文件(read)是另一个很耗时的操作P，那么相当于时间开销就变成原来的10倍了。
遇到这种情况我就一般把文本内容缓存下来，T()重构成T(text)。。。
这也给我了一个启示，读取文件操作千万别写在方法里，把待处理的文本作为接口似乎更好。。

3. 实验的中间数据要保存下来，以防多次实验重复计算这部分数据

由第二点引申开，可以把中间处理数据保存下来，从而跳过一些耗时的操作。。

待补充。。。

最后

以上就是感动红酒为你收集整理的总结一些写代码的的规范的全部内容，希望文章能够帮你解决总结一些写代码的的规范所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。