From 08dc3cd0b99a24751c02ce63cb8d356da1dcd68e Mon Sep 17 00:00:00 2001 From: Patrick Vogler Date: Wed, 21 Jun 2023 12:47:01 +0000 Subject: [PATCH] Update 'Coding Style' --- Coding-Style.md | 44 ++++++++++++++++++++++++++++++++++---------- 1 file changed, 34 insertions(+), 10 deletions(-) diff --git a/Coding-Style.md b/Coding-Style.md index 36b0fd4..9f5c8d2 100644 --- a/Coding-Style.md +++ b/Coding-Style.md @@ -1,5 +1,5 @@

- BigWhoop Document Headline + BigWhoop Document Headline

@@ -38,19 +38,43 @@ Above all, the following rule from the GNOME developer documentation should alwa ## Formatting Keep the length of source code lines to 100 characters or less to ensure maximum readability on most modern monitors with a reasonable font size. Longer lines of code are more difficult to read and understand. Too many indentations should be interpreted as an indication that code restructuring is required. ### Indentation - +Each new level is indented by 2 spaces, braces go on a line by themselves, and they are indented as well: ```c - while ((c = *str++)) - { - if ((c >= 97) && (c <= 122)) - { - c = c - 32; - } - hash = (hash * 33) ^ c; - } +while ((c = *str++)) + { + if ((c >= 97) && (c <= 122)) + { + c = c - 32; + } + hash = (hash * 33) ^ c; + } +``` +Continuation lines should align wrapped elements either vertically using Python’s implicit line joining inside parentheses, brackets and braces, or using a hanging indent [1]. When using a hanging indent the following should be considered; there should be no arguments on the first line and further indentation should be used to clearly distinguish itself as a continuation line: +```c +error = initialize_tagtree(&prec_control->tag_inclusion, + prec_control->numCbX, + prec_control->numCbY, + prec_control->numCbZ, + prec_control->numCbTS) +exit(error); +``` +```c +error = initialize_tagtree( + &prec_control->tag_inclusion, + prec_control->numCbX, + prec_control->numCbY, + prec_control->numCbZ, + prec_control->numCbTS); +exit(error); ``` ### Braces +```c +prec_control->numCodeblocks_a = (uint64)(prec_control->numCbX + * prec_control->numCbY + * prec_control->numCbZ + * prec_control->numCbTS); +``` ### Functions ### Derived Types