
1.7.2 给Hello, world!程序添加注释
刚才我们介绍了几种注释的形式及风格,现在就开始给hello1.c文件中的代码添加适当的注释。为此,我们先要将该文件复制一份,并把复制出来的这份文件命名为hello2.c。
你可以在命令解释器中将hello1.c复制为hello2.c,也可以用文本编辑器打开hello1.c文件,并立刻将其另存为hello2.c。无论采用哪种方式复制,这两份文件都应该出现在同一个目录,也就是存放本章范例代码的Chapter1_HelloWorld目录里面。
在编辑器里修改hello2.c文件,将其改成如下形式:

注意看,出现在/*与*/之间的那四行注释文字,每行的开头都有*符号,这样做可以清楚地表明这几行文字是同一段注释里面的内容。现在请你编译并运行该程序,然后验证它的结果是否正确。在添加注释的过程中,你可能会不小心在某个地方多写几个字符,你需要仔细核对,以保证自己写的代码跟刚才那段代码一致。
这个程序现在已经完整了。该程序的功能与hello1.c程序一样,而我们早前从hello1.c的运行结果中已能确定,这个程序是正确的,因为它确实以预期的方式显示了我们想要的消息。hello2.c的前六行注释提供了极其简单的信息,其中指出了程序的作者以及创建时间。程序文件开头的信息可以像本例一样写得极为简单,也可以写得更加复杂。就目前来说,我们还是先写得简单一些。
这个程序本身很简单,凡是懂C语言的人都知道它只不过是要打印一条消息而已。因此,不用再添加别的注释。
最后,我们还用一行注释标出了文件的结尾(End Of File,EOF)。这样做的好处就是,如果你同时打开了多个编辑器窗口,或者其中的程序特别长,那么阅读代码的人就可以通过这样一行注释知道某份代码文件在哪里结束。当然,在文件末尾标注EOF并不是一项必须遵守的原则,如果你不喜欢,也可以不标。
笔者发现,自己的注释风格会随着编写注释时所针对的编程语言而变化,如果那种语言很清晰,那么自己写的注释也会很精简,反之则会比较烦琐。笔者在大学用汇编语言写过代码,后来还用过早期版本的Fortran 4(Fortran IV)语言,那时,几乎每行代码都得写注释。但是笔者在用C++或Objective-C编程时却发现需要写的注释很少,就算有,也是那种针对某个概念或编程方案而写的大段注释。
另外,即便在同一门编程语言里面,注释的风格也依然有可能发生变化。比方说,如果要解决的问题有些不太寻常,或者解决该问题的方式比较新颖,那么需要添加注释的地方就会比较多。
在本书后续章节中,笔者会针对相关的范例代码告诉你怎样写出有效的注释,以使这些注释在代码发生变化后仍能成立。