Differences

This shows you the differences between two versions of the page.

--- design:coding_style_guide [2025/05/04 18:24] – asie
+++ design:coding_style_guide [2025/05/05 15:17] (current) – [Commenting] asie
@@ Line 31: / Line 31: @@
 ===== Code style =====
- * Braces are always on the same line, and are separated with a space.
+  * Braces are always on the same line, and are separated with a space.
- * If it doesn't otherwise hurt readability, using no braces for a single-line statement is fine.
+  * If it doesn't otherwise hurt readability, using no braces for a single-line statement is fine.
 <code c>
@@ Line 46: / Line 46: @@
 </code>
- * Pointers are declared with the asterisk ''*'' adjacent to the type name. ''const'' goes before the type name.
+  * Pointers are declared with the asterisk ''*'' adjacent to the type name. ''const'' goes before the type name.
 <code c>
@@ Line 52: / Line 52: @@
 </code>
-===== Commenting =====
+===== Documentation =====
 Use [[https://www.doxygen.nl/manual/docblocks.html|Doxygen-compatible]] formatting for all user-facing documentation comments:
@@ Line 58: / Line 58: @@
   * Javadoc-style ''%%/** .. */%%'' blocks for documenting functions, types, macros and/or where larger comment blocks are warranted;
   * For one-line comments, such as on enumerated types, ''%%///<%%'' can be used.
+  * When writing internal header macros/functions that are not meant for the library user, put such code between ''%%/// @cond INTERNAL%%'' and ''%%/// @endcond%%'' blocks.
 ===== Best practices =====