diff --git a/CODING_STANDARD.md b/CODING_STANDARD.md index 1c2f3cb27e..3d4516f99f 100644 --- a/CODING_STANDARD.md +++ b/CODING_STANDARD.md @@ -948,7 +948,7 @@ In an international environment English is the preferred language. #### [4.3.2] Use // for all comments, including multi-line comments. -An exception to this rule applies for jsdoc or Doxygen comments. +An exception to this rule applies to JSDoc and Doxygen comments. ```cpp // Comment spanning @@ -1008,3 +1008,11 @@ These types of comments are explicitly not allowed. If you need to break up sect //-------------------------------------------------------------------------------- ``` +#### [4.3.6] Doxygen comments should use "///" + +Use the `///` style of [Doxygen](https://www.doxygen.nl/index.html) comments when documenting public interfaces. + +Some editors can automatically create a Doxygen documentation stub if you type `///` in the line above the item to be +documented. + +**Visual Studio:** To configure Visual Studio's Doxygen commenting behavior, search for "Doxygen" in Tools > Options. diff --git a/tools/doxygen/README.md b/tools/doxygen/README.md index 34d12c1d8a..40f444ca07 100644 --- a/tools/doxygen/README.md +++ b/tools/doxygen/README.md @@ -12,6 +12,11 @@ Make a `/build/doxygen/` directory. If you want to run Doxygen from a command prompt, add the Doxygen install's `/bin` directory to your system PATH. +## Documenting + +See section 4.3.6 of the [*Coding Standard*](../../CODING_STANDARD.md). + + ## Running ### Using the Doxywizard GUI