第19章　编码风格

编码风格不属于技术范畴，但却受到越来越多的重视，随着程序规模的扩大，仅依靠一个人完成所有代码的编写是不可能的，程序员应当培养的是合作和交流的能力，而编码风格决定了程序的可读性，以写文章来作比喻，好的风格包括结构和条理清晰以及字体工整，这会让阅读者感觉十分舒服，也能很快领会文章的意思，而差的风格让人读起来完全摸不着头脑，何来交流可谈。

本章主要从版式、命名规则和项目文件的组织3个方面来讲述怎样为好的编码风格，重申一遍，这不属于技术范畴，而且没有统一的标准，业界也是争论不休，本章提出的仅是建议，仅供参考。

本章主要涉及以下知识点。

❑程序的排版：介绍在程序代码中排版应该注意的问题。

❑命名规则：介绍常用的几种命名规则。

❑项目文件的组织：介绍如何对项目中的文件进行划分。

19.1　程序的排版

排版这个词好像更多用于文字领域，其实代码文件也可以看成是一部作品，好的程序不仅要做到功能正确、效率高，还要书写规范便于阅读。

19.1.1　注释

很多程序员都有这样的体会，看几个月前自己写的代码，完全不知所云，读了半天才弄懂，相当于重新写了一遍。如果添加了注释，阅读和理解会快捷很多，注释往往应用于以下情况。

❑版本、版权声明以及文件介绍。

❑函数接口和功能说明。

❑重要的代码行或代码块。

注释的位置应与被描述的代码相邻，常放在代码的上方或右方，不推荐放在下方，而且，注释一定要清晰，读了让人更迷糊的注释不如不加。如果对代码进行了修改，注释的修改也要同步进行，否则会让读代码和注释的人摸不着头脑。

使用注释的另一个弊端是注释过多，每行都加注释是不必要的，注释过多也会惹人讨厌，关键是控制好一个度。

在结构复杂的代码块中，尤其是多重嵌套时，使用代码缩进固然能使层次更清晰，但在一些段落结束时添加注释能使结构更清晰，如下所示。