本节书摘来自异步社区《C语言编程初学者指南》一书中的第1章,第1.3节,作者【美】Keith Davenport(达文波特) , M1ichael Vine(维恩),更多章节内容可以访问云栖社区“异步社区”公众号查看
1.3 使用注释
在任何编程语言中,注释都是程序代码的一个组成部分。注释帮助表明程序的作用并且说明复杂的例程。无论是对于程序员本人(也就是你),还是查看你的代码的其他程序员来说,注释都很有用。
在下面的代码行中,编译器会忽略掉文本“C Programming for the Absolute Beginner”,因为这行文本用字符/和/括了起来。
/* C Programming for the Absolute Beginner */
字符/表示一个注释块的开始,而/表示一个注释块的结束。这些字符并不一定要在同一行中,它们可以用来创建单行注释,也可以用于多行注释。如下的代码块展示了一个多行注释:
/* C Programming for the Absolute Beginner
Chapter 1 – Getting Started with C Programming
*/
如果你漏掉了某一个注释字符,或者把某个注释字符用反了,C程序将无法正确地编译,或者根本就不会编译。例如,如下的代码段漏掉了一个注释字符,编译器不会编译它。
/* C Programming for the Absolute Beginner
下面这行代码也不会被编译,因为注释字符的顺序不对:
*/ C Programming for the Absolute Beginner */
技巧
如果你记不住注释符号的正确顺序,可以把它们想象为两个拿着球棒面对面打球的人。球棒(/)总是需要把球(*)打向另一个球棒,并且球还没有离开球棒而远去。
如果你的注释并不需要跨越多行,可以选择直接在注释之前使用双斜杠(//),如下所示:
//by Keith Davenport
陷阱
如果你的C编译器支持C++(gcc就支持),可以使用单行注释字符//来表示单行的注释。注意,并不是所有的C编译器都支持单行注释字符。
编译器会忽略掉//字符之后的、同一行中的任何字符。也可以使用//字符来创建多行注释,但是这样一来,在语句块中的每一行的前面,都需要使用双斜杠。例如,下面的代码创建了一个多行的注释块。
//C Programming for the Absolute Beginner
//Chapter 1 - Getting Started with C Programming
//by Keith Davenport