2010-03-27 36 views
8

当我通过开源项目的源文件,我常常在评论中遇到一些奇怪的词组好笑的看着意见 - C++

/*  
@brief ...... 
@usage..... 
@remarks.... 
@par.... 
*/ 

问题
阅读1.什么是他们(没有提到何时我正在学习C++)
2.他们是否有任何文档(其中)

+0

虽然,Doxygen注释实际上用/ **或///标记,而不是/ *和// – sellibitze 2010-08-29 19:54:17

回答

16

它们只是注释,因此在C++中没有特殊含义。他们可能会允许文档生成器(例如Doxygen)从评论中提取数据。

7

这些是为了一些自动文档生成器的味道。另一个程序运行代码,寻找你在那里看到的评论。 @...关键字标识文档应该如何布局,该程序直接从源代码生成漂亮的HTML或印刷文档。这是一种使代码更容易与代码保持同步的方法。