tyler.durden/notepad-plus-plus
1
0
Fork 0
mirror of https://github.com/notepad-plus-plus/notepad-plus-plus.git synced 2025-04-08 17:15:37 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source 
Make brace position more explicit in both .cpp & .h.
This commit is contained in:
Don HO 2022-02-17 14:02:00 +01:00 committed by GitHub
parent 47481c76e8
commit 010ce6f0f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@ -55,16 +55,21 @@ In short: The easier the code review is, the better the chance your pull request
* ###### Good:
```cpp
if ()
void MyClass::method1()
{
// Do something
if (aCondition)
{
// Do something
}
}
```
* ###### Bad:
```cpp
if () {
// Do something
void MyClass::method1() {
if (aCondition) {
// Do something
}
}
```
However, the method definition could be defined in a header file (.h), if there's one line code only. In this case, Java-like braces should be used.
@ -76,7 +81,8 @@ In short: The easier the code review is, the better the chance your pull request
void method1();
int method2() {
return _x; // only one line code can be placed in .h as method definition
}
};
private:
int _x;
}