3

While looking through Quick Controls 2.0 sources, I came upon a peculiar comment syntax that I can't seem to find in docs:

//! [property]
property: ...
...
//! [property]

for example, pairs of //! [contentItem], //! [background] could be seen in TabButton.qml.

I wonder if this is just a convention chosen by the developers to delimit regions of code, or does it indeed have some special meaning?

jpnurmi
  • 5,716
  • 2
  • 21
  • 37
sunny moon
  • 1,313
  • 3
  • 16
  • 30
  • 2
    Yep, definitely a duplicate... But to my defense, I surely did try to find an answer before asking. Any recommendations on how do I search for short strings on SO (as well as google them)? Searching `[qml] "//!"` gave me zero results. – sunny moon Oct 31 '16 at 18:57
  • I didn't find it either ;) – dtech Oct 31 '16 at 20:55

2 Answers2

4

With Qt comments that begin with ! are parsed to generate documentation. That applies to single and multi line comments.

In this particular case however it doesn't seem to contain any actual documentation, it is used to signify the lines where individual implementation details begin and end.

You can learn more about the documentation format here.

dtech
  • 47,916
  • 17
  • 112
  • 190
3

There used to be example code snippets on the Customizing Qt Quick Controls documentation page, that were automatically extracted from our own QML code with help of those qdoc-markers.

jpnurmi
  • 5,716
  • 2
  • 21
  • 37