Update CONTRIBUTING.md (#316)

Syntax highlighting for the example code
This commit is contained in:
Foxi 2024-07-23 17:56:31 +02:00 committed by GitHub
parent 7f990ea90d
commit f593204729
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -31,7 +31,7 @@ Follow the indentation/whitespace style shown below. Do not use tabs, use 4-spac
* For doc-comments (Doxygen comments), use /// if it's a single line, else use the /** */ style featured in the example. Start the text on the second line, not the first containing /**. * For doc-comments (Doxygen comments), use /// if it's a single line, else use the /** */ style featured in the example. Start the text on the second line, not the first containing /**.
* For items that are both defined and declared in two separate files, put the doc-comment only next to the associated declaration. (In a header file, usually.) Otherwise, put it next to the implementation. Never duplicate doc-comments in both places. * For items that are both defined and declared in two separate files, put the doc-comment only next to the associated declaration. (In a header file, usually.) Otherwise, put it next to the implementation. Never duplicate doc-comments in both places.
``` ```c++
// Includes should be sorted lexicographically // Includes should be sorted lexicographically
// STD includes first // STD includes first
#include <array> #include <array>