From ad6ff8431aad9ffecf641e1b79ab45c9ed80b0ef Mon Sep 17 00:00:00 2001 From: PirxDanford Date: Thu, 3 Nov 2022 11:21:58 +0100 Subject: [PATCH] Add slide about naming conventions --- slides/3_advanced_concepts.html | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/slides/3_advanced_concepts.html b/slides/3_advanced_concepts.html index ca45f43..1b13267 100644 --- a/slides/3_advanced_concepts.html +++ b/slides/3_advanced_concepts.html @@ -20,6 +20,7 @@

Advanced Concepts

@@ -48,6 +49,23 @@

Code Coverage

For more details see Code Coverage on Wikipedia.

There are several tools available,
known to work with shunit2 are bashcov and kcov.
+
+
+

Naming Conventions

+ Even though a variable name could be conceived as just an arbitrary placeholder and using anything like A, B, C, V1, V2 or I-have-data is just fine it becomes much more useful when used as a mnemonic value.

+ This means a coder or a team will reflect certain logical elements within variable names and will opt for a certain writing style.

+ For a great overview of different naming convention styles see https://devopedia.org/naming-conventions.

+
+
+ Some key points about naming conventions: +
    +
  • Never underestimate the time that is saved by improved readability!
    • +
  • When working on a defined product or within a team, you should have them.
    • +
  • It is fine to refine the usage via tribal knowledge e.g. within code reviews.
    • +
  • Bad naming conventions can ruin your mood!
    • +
+
+