zaine/org_web
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Auto-publish on Wed 27 Aug 22:34:03 BST 2025

Browse Source
This commit is contained in:
Zaine Arch
2025-08-27 22:34:03 +01:00
parent f59359ce0f
commit f7b8c4c276
34 changed files with 609 additions and 341 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
output/posts/clean-code/clean-code-chapter-3.html
View File

@@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2025-08-27 Wed 20:20 -->
<!-- 2025-08-27 Wed 22:32 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Clean Code: Chapter 3 Notes</title>
@@ -224,15 +224,15 @@
<h2>Table of Contents</h2>
<div id="text-table-of-contents" role="doc-toc">
<ul>
<li><a href="#orgb4f969f">Chapter 3: Functions</a>
<li><a href="#org8f14a94">Chapter 3: Functions</a>
<ul>
<li><a href="#org637fa37">Functions should be small</a></li>
<li><a href="#orgb8f0843">Do One Thing &amp; One Level of Abstraction</a></li>
<li><a href="#org545658e">Switch Statements</a></li>
<li><a href="#org0e0ecee">Use Descriptive Names</a></li>
<li><a href="#orgb9daa70">Function Arguments</a></li>
<li><a href="#org49cb262">Have No Side Effects</a></li>
<li><a href="#orga8581c3">Error Handling</a></li>
<li><a href="#org307e775">Functions should be small</a></li>
<li><a href="#org494d49b">Do One Thing &amp; One Level of Abstraction</a></li>
<li><a href="#org388f480">Switch Statements</a></li>
<li><a href="#orgef9c0c6">Use Descriptive Names</a></li>
<li><a href="#org659f406">Function Arguments</a></li>
<li><a href="#org59cfd1e">Have No Side Effects</a></li>
<li><a href="#orga4a5d03">Error Handling</a></li>
</ul>
</li>
</ul>
@@ -241,13 +241,13 @@
<p>
Link to <a href="clean-code-chapter-2.html">Chapter 2</a>
</p>
<div id="outline-container-orgb4f969f" class="outline-2">
<h2 id="orgb4f969f">Chapter 3: Functions</h2>
<div class="outline-text-2" id="text-orgb4f969f">
<div id="outline-container-org8f14a94" class="outline-2">
<h2 id="org8f14a94">Chapter 3: Functions</h2>
<div class="outline-text-2" id="text-org8f14a94">
</div>
<div id="outline-container-org637fa37" class="outline-3">
<h3 id="org637fa37">Functions should be small</h3>
<div class="outline-text-3" id="text-org637fa37">
<div id="outline-container-org307e775" class="outline-3">
<h3 id="org307e775">Functions should be small</h3>
<div class="outline-text-3" id="text-org307e775">
<p>
Functions should be extremely short—ideally just a few lines, so they remain easy to understand and maintain.
</p>
@@ -269,9 +269,9 @@ Large functions hide complexity and mix abstraction levels, making errors and du
</p>
</div>
</div>
<div id="outline-container-orgb8f0843" class="outline-3">
<h3 id="orgb8f0843">Do One Thing &amp; One Level of Abstraction</h3>
<div class="outline-text-3" id="text-orgb8f0843">
<div id="outline-container-org494d49b" class="outline-3">
<h3 id="org494d49b">Do One Thing &amp; One Level of Abstraction</h3>
<div class="outline-text-3" id="text-org494d49b">
<p>
A function should do exactly one conceptual task, and all its statements should exist at the same abstraction level.
</p>
@@ -293,9 +293,9 @@ Functions that “do one thing” cannot be logically split into sections such a
</p>
</div>
</div>
<div id="outline-container-org545658e" class="outline-3">
<h3 id="org545658e">Switch Statements</h3>
<div class="outline-text-3" id="text-org545658e">
<div id="outline-container-org388f480" class="outline-3">
<h3 id="org388f480">Switch Statements</h3>
<div class="outline-text-3" id="text-org388f480">
<p>
Switch statements naturally violate “do one thing” by handling multiple cases; they also grow in size over time.
</p>
@@ -350,9 +350,9 @@ Example:
</div>
</div>
</div>
<div id="outline-container-org0e0ecee" class="outline-3">
<h3 id="org0e0ecee">Use Descriptive Names</h3>
<div class="outline-text-3" id="text-org0e0ecee">
<div id="outline-container-orgef9c0c6" class="outline-3">
<h3 id="orgef9c0c6">Use Descriptive Names</h3>
<div class="outline-text-3" id="text-orgef9c0c6">
<p>
A function’s name should clearly state its purpose. Long, descriptive names beat short, cryptic ones.
</p>
@@ -374,9 +374,9 @@ IDE refactoring tools make renaming safe, encouraging experimentation.
</p>
</div>
</div>
<div id="outline-container-orgb9daa70" class="outline-3">
<h3 id="orgb9daa70">Function Arguments</h3>
<div class="outline-text-3" id="text-orgb9daa70">
<div id="outline-container-org659f406" class="outline-3">
<h3 id="org659f406">Function Arguments</h3>
<div class="outline-text-3" id="text-org659f406">
<p>
<div class="epigraph"><blockquote>The ideal number of arguments for a function is zero (niladic). Next comes one (monadic), followed closely by two (dyadic). Three arguments (triadic) should be avoided where possible. More than three (polyadic) requires very special justification—and then shouldn’t be used anyway.</blockquote></div>
</p>
@@ -402,9 +402,9 @@ Match function/argument names in verb–noun or keyword style (e.g., <code>write
</p>
</div>
</div>
<div id="outline-container-org49cb262" class="outline-3">
<h3 id="org49cb262">Have No Side Effects</h3>
<div class="outline-text-3" id="text-org49cb262">
<div id="outline-container-org59cfd1e" class="outline-3">
<h3 id="org59cfd1e">Have No Side Effects</h3>
<div class="outline-text-3" id="text-org59cfd1e">
<p>
A function should do only what its name promises. Hidden state changes are misleading and dangerous.
</p>
@@ -426,9 +426,9 @@ Functions that modify state and return information often cause confusion and sho
</p>
</div>
</div>
<div id="outline-container-orga8581c3" class="outline-3">
<h3 id="orga8581c3">Error Handling</h3>
<div class="outline-text-3" id="text-orga8581c3">
<div id="outline-container-orga4a5d03" class="outline-3">
<h3 id="orga4a5d03">Error Handling</h3>
<div class="outline-text-3" id="text-orga4a5d03">
<p>
Error handling is a single responsibility—separate it from normal logic to keep both paths clear.
</p>