We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 9cc906a commit 5765748Copy full SHA for 5765748
doc/src/dev/coding_style.rst
@@ -188,6 +188,14 @@ Incorrect usage:
188
189
/* Non-Doxygen block comment */ // Not permitted
190
191
+.. note::
192
+
193
+ This strict separation between `/* ... */` and `//` comments is designed to improve readability and reduce mistakes.
194
+ Using `/* ... */` only for Doxygen documentation makes it clear at a glance which comments are meant for generated docs,
195
+ and which are for developers reading the code. When Doxygen (or similar) comments are visually distinct from inline implementation comments,
196
+ it's harder to accidentally generate incomplete or misleading API documentation.
197
198
199
When to Comment
200
---------------
201
0 commit comments