本节书摘来自异步社区出版社《C++入门经典(第6版)》一书中的第2章,第2.3节,作者: 【美】Rogers Cadenhead(罗格斯 卡登海德) , Jesse Liberty(杰西 立波提) ,更多章节内容可以访问云栖社区“异步社区”公众号查看。
在您编写程序时,每行源代码的功能显而易见,但随着时间的流逝,再回过头来修复程序Bug或添加新功能时,可能发现对自己以前做的工作感到一头雾水。
为了避免这种困境,并帮助他人理解您编写的程序,可在源代码中添加注释。注释是阐述程序做什么的文本,编译器对其置之不理,因此只能给阅读代码的人带来好处。
在C++中,有两种类型的注释。单行注释以两个斜杠(//)打头,导致编译器忽略从这里开始到行尾的全部内容,下面是一个例子:
// The next line is a kludge (ugh!)多行注释以斜杠和星号(/)打头,并以星号和斜杠(/)结尾。/和/之间的所有内容都是注释,哪怕它们占据多行。如果程序中不存在与/配套的/,编译器将视之为错误。下面是一个多行注释:
/* This part of the program doesn't work very well. Please remember to fix this before the code goes live –– or else find a scapegoat you can blame for the problem. The new guy Curtis would be a good choice. */在上述注释中,为了提高可读性而将文本左对齐,但并非必须这样,因为编译器忽略/和/之间的所有内容。在这里,可包含任何内容:杂货清单、情诗、从未告诉过别人的秘密等。
watch
警告:关于多行注释,需要牢记的一个重点是,不能将其嵌套。如果您使用/开始注释,并在几行后又使用了一个/,则编译器见到第一个/后,将认为多行注释到此结束,这样第二个/将导致编译器错误。大多数C++编辑器都以不同的颜色显示注释,让注释的开始和结束位置非常清晰。在稍后您将创建的项目中,包含了这两种类型的注释。请在程序中添加大量注释,您为解释代码的功能而在编写注释上花的时间越多,几周、几月甚至几年后,代码就越容易理解。
相关资源:Visual C 2008入门经典--详细书签版