【本文最后更新时间：2018年9月19日】
在科研工作中，代码的阅读、调试与共享不可避免。前段时间，笔者整理并公开了所发表论文的代码。因为当时写的代码可读性较差，笔者在读一些代码段的时候发现根本无法get到自己当初的思路，整理代码的过程耗费了很多精力。因而笔者愈发觉得写代码时增强其可读性非常必要，赏心悦目的代码可以大大节约科研工作者的时间，于人于己都会带来很大的便利。近日笔者对如何增强代码的可读性进行了学习，在这里总结并分享一下相关的tips，欢迎留言区评论指正！
一、为什么要增强代码的可读性
（1）降低代码的调试成本与维护成本；
（2）提高代码的可拓展性；
（3）有利于学术交流；
（4）有利于团队开发；
二、几类降低代码可读性的不良编程习惯
（1）代码不良。例如，奇怪的变量名（无意义的单个字母、汉语拼音与英文混用），上千行的冗余函数（代码段的直接复制），无注释或错误注释；
（2）代码的格式不正确或不一致。例如，不使用或者过度使用空格、缩进及回车；
（3）代码的风格不一致，例如主函数与子函数里面含义相同的变量采用不同的变量名，或者变量命名的风格不一致；
（4）代码中包含冗余代码。例如，相同功能的代码段简单复制；
（5）未备注的低层次优化。例如，为了节省内存、追求效率而牺牲代码的逻辑性；
（6）代码过于高明，即代码过于简单但是理解起来相当困难。例如不加说明地使用了需要推导才能得到的结论；
三、增强代码可读性的几个策略
（1）编码风格要统一，如果是团队合作，最好要有编码规范；
（2）代码要能够清晰表达意图。例如，使用别人看得懂的单词缩写，避免不同语言混用，使用恰到好处的注释，将程序模块化为不同的子函数以避免程序段的复制，每个函数下不同功能的代码段落化（段前可以加注释说明程序段的功能）；
（3）不要追求代码能够实现所有的功能，也不要把代码写死；
（4）避免做没有太大价值的优化工作从而牺牲代码的可读性；
（5）多读多练，不断尝试写出简单而优美的代码；
最后，笔者自作一首打油诗总结上述的几个要点：
简洁凝练莫讨巧，
适度封装与嵌套，
高度内聚低耦合，
注释简明又扼要。
学术需要交流，科研需要合作。我们要尽量争取使得自己写出来的代码能让其他人读懂，这个“其他人”当然也包括一周后的自己。