TOPIO/BigWhoop
TOPIO/BigWhoop
4
1
Fork 0
Code Issues 26 Pull requests 1 Projects 6 Releases Packages Wiki Activity

Update 'Coding Style'

Patrick Vogler 2023-06-21 14:50:46 +00:00
parent 0a4538ca06
commit 7b8bafd7c6
1 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
Coding-Style.md

@ -51,16 +51,30 @@ while ((c = *str++))
hash = (hash * 33) ^ c;
}
```
Continuation lines should align wrapped elements with the first argument (excluding reference operators) or use a hanging indent. When using a hanging indent, there should be no arguments on the first line and all subsequent "hanging" lines should be indented with 2 spaces in relation to the calling command:
#### Aligned Along First Deliminator
```c
# Correct
error = initialize_tagtree(&prec_control->tag_inclusion,
prec_control->numCbX,
prec_control->numCbY,
prec_control->numCbZ,
prec_control->numCbTS)
exit(error);
# Wrong
error = initialize_tagtree(&prec_control->tag_inclusion,
prec_control->numCbX,
prec_control->numCbY,
prec_control->numCbZ,
prec_control->numCbTS)
exit(error);
```
#### Hanging Indent
```c
# Correct
error = initialize_tagtree(
&prec_control->tag_inclusion,
prec_control->numCbX,
@ -68,6 +82,15 @@ error = initialize_tagtree(
prec_control->numCbZ,
prec_control->numCbTS);
exit(error);
# Wrong
error = initialize_tagtree(
&prec_control->tag_inclusion,
prec_control->numCbX,
prec_control->numCbY,
prec_control->numCbZ,
prec_control->numCbTS);
exit(error);
```
### Braces