add clang format notes

This commit is contained in:
vaxerski 2022-12-16 17:22:44 +00:00
parent b597ca16a0
commit 2f1b29815f

View file

@ -6,53 +6,9 @@
## Code Style
Hyprland's code style:
Hyprland's code style is governed by the `.clang-format` file.
```cpp
void myFunction(int arg) {
if (shortStatement)
doSomething();
else
doNotDoIt();
switch (value) {
case 1:
{ // braces optional
blahBlah();
break;
}
default:
Debug::log(ERR, "error");
break;
}
const auto CONSTVALUE = arg == 1 ? 2 : 3;
void* pLocalPointer = nullptr;
int localValue = 0;
if (MY && VERY && LONG && IF && STATEMENT && OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO && SUPERLONG && STATEMENT) {
; // blank
}
}
class myClass {
public:
int m_iMyLocalInt = 0;
// ^ member
// ^ int
// ^ camel name
void classFunction(int, int, bool defaultBool = false);
// ^ most arg names omitted
// ^ arg name mandatory here because C++
// Note: omitting args only for functions with clear / few args. For long functions:
void classFunctionLong(int a, int b, bool sure, bool red, bool enabled, void* item, const CColor& color = {0});
}
```
Make sure to format accordingly whenever you make a PR.
## Some code FAQ