简体   繁体   English

块注释中的感叹号在 C++ /*! 中意味着什么?<comment> +/</comment>

[英]What does the Exclamation mark in block comment means in C++ /*! <comment>+/

I have a header file in c++ , where the declaration of the functions has a block comment with an exclamation mark !我在c++中有一个头文件,其中函数的声明有一个带有感叹号的块注释! . .

Example例子

class test{
 public:
        /*! @fn test::test()
            @brief The basic constructor, which initializes the _test handle.
        */
        test();

        /*! @fn test::upload(std::string url)
            @brief A function to execute a http POST request with the given url and image.

            @param[in] url The url we are POSTing to
            @return The response of the server
        */
        std::string upload(std::string url);
}

also it changes the color of the comment in VSCode like this它还会像这样更改 VSCode 中注释的颜色在此处输入图像描述

What does this exclamation mark mean in the comment?评论里这个感叹号是什么意思?

Thanks in advance提前致谢

These comments are for the Doxygen system that automatically generates documentation from code.这些注释适用于自动从代码生成文档的Doxygen 系统

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM