Skip to content

Commit

Permalink
Add slide about naming conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
PirxDanford committed Nov 3, 2022
1 parent 736a868 commit ad6ff84
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions slides/3_advanced_concepts.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ <h1>Advanced Concepts</h1>
<ul>
<li>Test Doubling</li>
<li>Code Coverage</li>
<li>Naming Conventions</li>
</ul>
</section>
<section>
Expand Down Expand Up @@ -48,6 +49,23 @@ <h4>Code Coverage</h4>
For more details see <a href="https://en.wikipedia.org/wiki/Code_coverage" target="_blank">Code Coverage on Wikipedia</a>.<br><br>
There are several tools available,<br>known to work with shunit2 are bashcov and kcov.
</section>
<section>
<section>
<h4>Naming Conventions</h4>
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 <a href="https://en.wikipedia.org/wiki/Mnemonic" target="_blank">mnemonic</a> value.<br><br>
This means a coder or a team will reflect certain logical elements within variable names and will opt for a certain writing style.<br><br>
For a great overview of different naming convention styles see <a href="https://devopedia.org/naming-conventions">https://devopedia.org/naming-conventions</a>.<br><br>
</section>
<section>
Some key points about naming conventions:
<ul>
<li>Never underestimate the time that is saved by improved readability!</li>
<li>When working on a defined product or within a team, you should have them.</li>
<li>It is fine to refine the usage via tribal knowledge e.g. within code reviews.</li>
<li>Bad naming conventions can ruin your mood!</li>
</ul>
</section>
</section>
</div>
</div>

Expand Down

0 comments on commit ad6ff84

Please sign in to comment.