Question

Qt Creator normally colors comments green, but I saw blue colored comments in the Qt Examples, and Qt Creator seems to color every comment that starts with //! in blue.

Here's an example screenshot:

enter image description here

Is this some convention? What does the blue signify?

Was it helpful?

Solution

It's a Doxygen comment.

There are multiple styles:

Qt block comment:

/*!
... text ...
*/

Qt one-line comment:

//! ... one line of text ...

JavaDoc block comment:

/**
  * ... text ...
*/

JavaDoc one-line comment:

/// ... one line of text ...

OTHER TIPS

Comments that begin with //! are the Qt style for code documentation as contrasted with regular comments. See the doxygen manual for details on the structure of it, but basically, these kinds of comments are intended for automatic extraction into documentation about the code.

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top