From 618ae28127a5a920e0fce15f545492e52c5711fc Mon Sep 17 00:00:00 2001 From: Patrick Vogler Date: Wed, 21 Jun 2023 14:29:56 +0000 Subject: [PATCH] Update 'Coding Style' --- Coding-Style.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/Coding-Style.md b/Coding-Style.md index 0b281a5..1e24769 100644 --- a/Coding-Style.md +++ b/Coding-Style.md @@ -38,7 +38,33 @@ 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: +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