From 10adb0b486afd6492eb2e39365d028ca6447ddc9 Mon Sep 17 00:00:00 2001 From: nils <48135649+Nilstrieb@users.noreply.github.com> Date: Wed, 27 Jul 2022 22:26:33 +0200 Subject: [PATCH] Update conventions.md --- src/conventions.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/src/conventions.md b/src/conventions.md index 1aba074..48526fe 100644 --- a/src/conventions.md +++ b/src/conventions.md @@ -11,4 +11,20 @@ you can use it freely in your program. ## 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. \ No newline at end of file +`#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 +} +```