QQ客服
微信客服 扫码加微信
<h2>Conclusion: Professionalism</h2> <p>Clean code is not perfectionism—it’s respect for your future self and your teammates. Leave the codebase better than you found it. Refactor continuously, review each other’s work, and never accept “it works” as a substitute for “it’s clean.”</p>
<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Clean Code - A Solid Guide</title> <style> /* Reset & base typography for clean reading */ body { font-family: Georgia, "Times New Roman", Times, serif; line-height: 1.5; margin: 0; padding: 0; color: #1a1a1a; background-color: #fefefe; } h1, h2, h3 { font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; font-weight: normal; margin-top: 1.5em; margin-bottom: 0.5em; page-break-after: avoid; } h1 { font-size: 1.8em; text-align: center; margin-top: 2em; margin-bottom: 1em; border-bottom: 1px solid #ccc; padding-bottom: 0.3em; } h2 { font-size: 1.5em; border-left: 4px solid #2c6e2c; padding-left: 0.6em; } h3 { font-size: 1.3em; font-style: italic; color: #2c6e2c; } p, li, blockquote { text-align: justify; hyphens: auto; } code { font-family: "Courier New", Courier, monospace; background-color: #f5f5f5; padding: 0.2em 0.4em; border-radius: 3px; font-size: 0.9em; white-space: pre-wrap; } pre { background-color: #f5f5f5; padding: 1em; border-left: 4px solid #2c6e2c; overflow-x: auto; font-size: 0.85em; font-family: "Courier New", Courier, monospace; margin: 1.2em 0; border-radius: 0 6px 6px 0; } .bad, .good { padding: 0.8em; margin: 1em 0; border-radius: 6px; } .bad { background-color: #ffe6e6; border-left: 6px solid #c00; } .good { background-color: #e6ffe6; border-left: 6px solid #2c6e2c; } .bad:before { content: "❌ Avoid: "; font-weight: bold; color: #a00; } .good:before { content: "✅ Prefer: "; font-weight: bold; color: #2c6e2c; } .tip { background-color: #eef4ff; padding: 0.8em; margin: 1em 0; border-radius: 6px; border-left: 6px solid #1e6f9f; } .tip:before { content: "💡 Tip: "; font-weight: bold; color: #1e6f9f; } ul, ol { margin: 0.8em 0; padding-left: 1.5em; } li { margin: 0.3em 0; } hr { margin: 2em 0; border: none; border-top: 1px dotted #bbb; } .footer { margin-top: 3em; font-size: 0.8em; text-align: center; color: #777; border-top: 1px solid #ddd; padding-top: 1em; } @media (prefers-color-scheme: dark) { body { background-color: #1e1e1e; color: #e0e0e0; } code, pre { background-color: #2d2d2d; } .bad { background-color: #2a1a1a; } .good { background-color: #1a2a1a; } .tip { background-color: #1a2a3a; } } </style> </head> <body> <h1>Clean Code: A Solid Guide</h1> <p style="text-align: center; font-style: italic;">Practical principles for writing readable, maintainable, and honest software.</p>
<p>Use <strong>Special Case Pattern</strong> instead of returning null:</p> <div class="good"> <pre>class NullUser extends User { String getName() { return "guest"; } boolean isNull() { return true; } }</pre> </div> codigo limpo epub
<p>Legal comments, TODO notes, and warnings are acceptable but keep them brief. Avoid commented-out code—delete it. Your VCS history will remember.</p>
<h3>No side effects</h3> <p>A function named <code>checkPassword()</code> should not also initialize a session. Do one thing.</p> Avoid commented-out code—delete it
<h3>One level of abstraction per function</h3> <p>Mixing high-level business logic with low-level file I/O is a common smell.</p> <div class="bad"> <pre>void processOrder(Order order) { // high level validateOrder(order); // low level Files.writeString(Path.of("log.txt"), "Processing"); // high level again applyDiscount(order); }</pre> </div>
</body> </html>
<ul> <li><strong>Vertical density</strong>: Related concepts should be close. Local variables at the top of a function, helper functions directly below the calling function.</li> <li><strong>Horizontal spacing</strong>: Use spaces around operators (<code>a + b</code>), not tabs or chaotic mixtures. One indentation level = 4 spaces.</li> <li><strong>Team rules</strong>: If you work in a team, agree on an automatic formatter (Prettier, Black, gofmt).</li> </ul>
<h3>Small! Really small</h3> <p>An entire function should rarely exceed 20 lines. If you need a comment to explain a block inside a function, extract that block into a new function.</p> Local variables at the top of a function,
<div class="bad"> <pre>try { deletePage(page); registry.deleteReference(page.name); } catch (Exception e) { logError(e); throw new RuntimeException(); }</pre> </div>