第3章 程序的样式
在《高质量程序设计指南(C++/C语言)》中,作者说:可以把程序的版式比喻为“书法”,好的“书法”可以让人对程序一目了然,看得兴致勃勃。确实,我们一打开程序,首先看到的便是程序的排版,我们的第一印象便是程序写得是工整还是凌乱。都说第一印象很重要,为了给大家留下好的第一印象,我们一定要注重程序的版式。
此外,好的注释能够帮助读者更快地理解程序,提高工作效率。也许是因为工作比较忙的缘故,很多软件工程师不喜欢为自己的程序写注释,认为这样做是没有必要的。那么,如果给他一份毫无注释的代码,他会有什么样的感受呢?在程序中,优美的、得当的注释能够起到锦上添花的作用,更能够体现出一个工程师的专业素质。因此,写注释实在是很有必要的。
本章介绍头文件、源文件(也被称作定义文件)的样式,空格、空行、大括号的使用和注释的书写。本章中的示例代码均是基于开发项目实践中的编码规范来编写的。
3.1 头文件
头文件起到一个辅助的作用,简要地反应出本程序的基本功能。采用以下的样式来书写头文件:
/*************************************************