I have a header file in c++
, where the declaration of the functions has a block comment with an exclamation mark !
.
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
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.
The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.