- Qt Creator Documentation
- Documentation Comments
- Qt Creator 21.0.0-beta1

Display ◦ Editing code

# Documentation Comments

To set global preferences for documentation comments, select Preferences > Text Editor > Documentation Comments.

To override the global preferences for a particular project, see Document code.

The following table describes the preferences you can set.

Preference | Description
--- | ---
Enable Doxygen blocks | Automatically create a Doxygen comment when you press Enter after typing `/**`, `/*!`, `//!`, or `///`.
Generate brief description | Add a `brief` command with an initial description for the documented declaration. Available when Enable Doxygen blocks is selected.
Add leading asterisks | Add leading asterisks when you continue a C, C++, or Java documentation comment (`/*`, `/*!`, or `/**`) on a new line.
Doxygen command prefix | Select whether to prefix Doxygen commands with `@` or `\\`. Doxygen allows both. Select Automatic to use `@` if the surrounding comment starts with `/**` or `///`, and `\\` if it starts with `/*!` or `//!`.

See also Document code and How to: Configure editors.

Display ◦ Editing code