提前认识软件开发（6）：程序的版式和注释

提前认识软件开发（6）：程序的版式和注释2015-01-24第1部分重新认识C语言

程序的版式和注释

在《高质量程序设计指南（C/C++语言）》中，作者说：可以把程序的版式比喻为“书法”，好的“书法”可以让人对程序一目了然，看得兴致勃勃。确实，我们一打开程序，首先看到的便是程序的排版，我们的第一印象便是程序写得是工整还是凌乱。都说第一印象很重要，为了给大家留下好的第一印象，我们一定要注重程序的版式。

此外，好的注释能够帮助读者更快地理解程序，提高工作的效率。也许是因为工作比较忙的缘故，很多软件工程师不喜欢为自己的程序写注释，认为这样做是没有必要的。那么，如果给他一份毫无注释的代码，他会有什么样的感受呢？在程序中，优美的、得当的注释能够起到锦上添花的作用，更能够体现出一个工程师的专业素质。因此，写注释实在是很有必要的。

在C语言程序中，一般都包括了头文件（.h文件）和实现文件（.c文件），它们的版式及注释如下：

第一，头文件的版式和注释。

头文件起到一个辅助的作用，简要地反应出本程序的基本功能。

一般说来，头文件的版式可采用以下的样式：

/***************************************************************

*文件名称：

*内容摘要：

*其它说明：

*当前版本：

*作者：

*完成日期：

*修改记录1： //修改历史记录，包括修改日期、版本号、修改人及修改内容等

* 修改日期：

* 版本号：

* 修改人：

* 修改内容：

***************************************************************/

#ifndef _XXX_H //防止头文件被重复引用

#define _XXX_H

/**************************************************************