OpenPunk/yuzu
1
0
Fork 0
mirror of https://github.com/yuzu-emu/yuzu.git synced 2024-11-23 11:10:09 +00:00
Code Issues Projects Releases Wiki Activity

Minor revision to code style guidelines

LC 2020-12-05 07:18:45 -05:00
parent f754cc376e
commit 1d183ff11a
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
Contributing.md

@ -42,6 +42,7 @@ Follow the indentation/whitespace style shown below. Do not use tabs, use 4-spac
```cpp ```cpp
// Includes should be sorted lexicographically // Includes should be sorted lexicographically
// STD includes first // STD includes first
#include <array>
#include <map> #include <map>
#include <memory> #include <memory>
@ -60,15 +61,15 @@ namespace Example {
// Namespace contents are not indented // Namespace contents are not indented
// Declare globals at the top // Declare globals at the top (better yet, don't use globals at all!)
int g_foo{}; // {} can be used to initialize types as 0, false, or nullptr int g_foo{}; // {} can be used to initialize types as 0, false, or nullptr
char* g_some_pointer{}; // Pointer * and reference & stick to the type name, and make sure to initialize as nullptr! char* g_some_pointer{}; // Pointer * and reference & stick to the type name, and make sure to initialize as nullptr!
/// A colorful enum. /// A colorful enum.
enum SomeEnum { enum class SomeEnum {
ColorRed, ///< The color of fire. Red, ///< The color of fire.
ColorGreen, ///< The color of grass. Green, ///< The color of grass.
ColorBlue, ///< Not actually the color of water. Blue, ///< Not actually the color of water.
}; };
/** /**
@ -76,7 +77,9 @@ enum SomeEnum {
* Note that the asterisks are indented by one space to align to the first line. * Note that the asterisks are indented by one space to align to the first line.
*/ */
struct Position { struct Position {
int x{}, y{}; // Always intitialize member variables! // Always intitialize member variables!
int x{};
int y{};
}; };
// Use "typename" rather than "class" here // Use "typename" rather than "class" here
@ -84,7 +87,7 @@ template <typename T>
void FooBar() { void FooBar() {
const std::string some_string{"prefer uniform initialization"}; const std::string some_string{"prefer uniform initialization"};
int some_array[]{ const std::array<int, 4> some_array{
5, 5,
25, 25,
7, 7,
@ -92,13 +95,13 @@ void FooBar() {
}; };
if (note == the_space_after_the_if) { if (note == the_space_after_the_if) {
CallAfunction(); CallAFunction();
} else { } else {
// Use a space after the // when commenting // Use a space after the // when commenting
} }
// Place a single space after the for loop semicolons, prefer pre-increment // Place a single space after the for loop semicolons, prefer pre-increment
for (int i{}; i != 25; ++i) { for (int i = 0; i != 25; ++i) {
// This is how we write loops // This is how we write loops
} }
@ -113,24 +116,21 @@ void FooBar() {
// several lines. // several lines.
} }
// No indentation for case labels
switch (var) { switch (var) {
// No indentation for case label
case 1: { case 1: {
int case_var{ var + 3 }; const int case_var{var + 3};
DoSomething(case_var); DoSomething(case_var);
break; break;
} }
case 3: case 3:
DoSomething(var); DoSomething(var);
return; return;
default: default:
// Yes, even break for the last case // Yes, even break for the last case
break; break;
} }
std::vector<T> you_can_declare, a_few, variables, like_this;
} }
} } // namespace Example
``` ```