我正在学习C++,在设置VS代码时,我在它的一个教程中发现了以下内容。
这只是一个演示程序。但是我的问题是关于在评论中使用@
符号作为...标题的惯例?
#include <iostream>
#include <vector>
#include <string>
using namespace std;
/**
* @brief An example program. This program demonstrates simple vector storage and element iteration.
* A welcome string is output to the user.
*
* @return Returns 0 when execution completes succesfully.
*/
int main() {
...
}
只是个风格问题。
1条答案
按热度按时间nbnkbykc1#
@是工具Doxygen使用的符号,该工具解析源文件并将标记的注解转换为更正式的文档。
有关详细信息,请参见Doxygen documentation.中的Documenting the Code