Doxygen风格函数注释初见

1 问题

在很多代码里都会看到类似这样的注释：

鼠标放到函数名上，会出现一个框，框里是我们写在函数上方的注释内容。

2 解释

这个是Doxygen注释。
上面是一个函数注释的例子，用于描述函数的功能和参数。上述注释是用Doxygen格式写的，Doxygen是一种常见的用于从源代码生成API文档的格式（或者说工具）。许多IDE都提供对从函数注释生成文档这一功能的支持。

3 后续

以后开发中肯定会经常用Doxygen，来让代码更加地规范，现在只是specify了这个问题，先Mark下来，日后会对本文进行补充。