H3cJP/yuzu
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add comment style notes to CONTRIBUTING.md

Browse Source 
Closes #215
This commit is contained in:
Yuri Kunde Schlesner 2014-11-23 19:44:00 -02:00
parent aa986370f3
commit eee8cc67da
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
CONTRIBUTING.md
View File

@ -24,6 +24,10 @@ Citra is a brand new project, so we have a great opportunity to keep things clea
### Indentation/Whitespace Style ### Indentation/Whitespace Style
Follow the indentation/whitespace style shown below. Do not use tabs, use 4-spaces instead. Follow the indentation/whitespace style shown below. Do not use tabs, use 4-spaces instead.
### Comments
* For regular comments, use C++ style (`//`) comments, even for multi-line ones.
* 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 `/**`.
```cpp ```cpp
namespace Example { namespace Example {
@ -33,12 +37,17 @@ namespace Example {
int g_foo = 0; int g_foo = 0;
char* g_some_pointer; // Notice the position of the * char* g_some_pointer; // Notice the position of the *
/// A colorful enum.
enum SomeEnum { enum SomeEnum {
COLOR_RED, COLOR_RED, ///< The color of fire.
COLOR_GREEN, COLOR_GREEN, ///< The color of grass.
COLOR_BLUE COLOR_BLUE ///< Not actually the color of water.
}; };
/**
* Very important function that does a lot of stuff.
* Note that the asterisks are indented by one space.
*/
struct Position { struct Position {
int x, y; int x, y;
}; };