C++基础之注释

前言

注释在程序编写中很重要，一个良好的注释在编写注释时更重要

一、注释的语法

注释有两种风格的语法：

1. c风格或者说“多行”注释：

/*
*只是一个c风格的注释 
*或者说是多行注释
*/

1. c++风格 或者说“单行”注释：

// 这是单行注释

注释实际上在编译过程中会被编译器忽略。每段注释都会被替换成空白字符，从程序中移除。

二、注意

1. c风格的注释块是不能被嵌套的，但是c风格和c++风格的注释是可以互相嵌套的。
2. 注释会在预处理阶段前就已经被移除，所以不能使用宏来组成注释。
   例如 : #define ABC 1//123456
3. 可以使用

#if 0
	代码段
#endif

if(false)
{
	代码段
}

来实现注释代码。

三、优美的注释

1. 为代码编写文档：一般写在源文件头部，注释一些不能通过阅读代码而得到的信息，比如该篇代码主要实现的功能，代码的版权，作者，编写日期等。
   

2. 写在函数头的注释：注释函数实现的功能，输入参数、输出参数、返回值以及异常处理等。
   

3. 数据结构声明的注释（包括结构体，类，枚举等）：如果其命名不够充分说明该数据结构表示的内容的话，应该为该结构体添加描述性的注释，应该放在数据结构声明的上方。对于数据结构中的域都应该注释在域的右方。
   以上图片皆选自开源库libsrt。

四、总结

优秀的代码本来就是容易阅读和理解，而注释只需要提供有需要的附加信息，所以应该把重点放在如何写好代码，而不是如何添加更多的注释来说明一堆难以阅读的代码上。