Noratrieb/nilstrieb-c-style-guide-edition-2
1
0
Fork 0
mirror of https://github.com/Noratrieb/nilstrieb-c-style-guide-edition-2.git synced 2026-01-14 15:25:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update conventions.md

Browse source
This commit is contained in:
nora 2022-07-27 22:26:33 +02:00 • committed by GitHub
parent de7d2e1214
commit 10adb0b486
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

16
src/conventions.md
View file

@ -12,3 +12,19 @@ you can use it freely in your program.
## Includes ## Includes
`#include` directives shall be placed at the start of the file. But usually, it's better to not use the preprocessor at all. Paste the code in by hand so that it is clearly visible in version control. `#include` directives shall be placed at the start of the file. But usually, it's better to not use the preprocessor at all. Paste the code in by hand so that it is clearly visible in version control.
## Identifers
All identifiers should be given meaningful english names. To work with ancient linkers, function names should contain six characters at most.
## Comments
Comments are vital to readability. Therefore, code should always be well comment. Comments must be written in the lingua franca of programming, swiss german.
```c
int main() {
int five = 5; // füüf
printf("Your number: %d", five); // äm benutzer füüf usgee
}
```