3. Self documenting code: avoid belaboured comments

Moment at 4:05 in My 10 “Clean” Code Principles (Start These Now) by Conner Ardman.

My 10 “Clean” Code Principles (Start These Now)

Saved by Wilbert Verayin.

Links to other pages

• Home
• 24
• Recent
• Vikis
• Creators
• Search

Discover other moments and creators

• 1. Eliminate if/else branching; early termination
• 2. Ambiguous definitions: ‘is’ function prefix to denote boolean return
• 3. Self documenting code: avoid belaboured comments
• 4. Consistent formatting. Use Eslint + Prettier to automate code style
• 5. DRY business logic. Look for opportunities to refactor. Make sure to test!
• 6. Fail or exit functions fast. Related to 1.
• 7. Avoid magic values - declare and use CONSTANTS instead.
• 8. Avoid violating single responsibility. Prefer to use pure functions (no side effects)
• 9. Overly clever code (code golf). Leads to impenetrable single liners (have to rewrite in order to debug)
• 10. Premature optimisations.
• 1. Eliminate if/else branching, use early termination
• 2. Ambiguous definitions: “is” function prefix clearly returns booleans
• 3. Self-documenting code, avoid belaboured comments
• 4. Consistent formatting, use Eslint + Prettier to automate code style
• 5. DRY (don't repeat yourself), look for opportunities to refactor, make sure to test
• 6. Fail or exit functions fast, related to 1 above
• 7. Avoid magic values, declare and use constants instead
• 8. Avoid violating single responsibility, use pure functions with no side effects
• 10. Premature optimisation

• "Fools!" said I "You do not know"
• The bureaucracy is expanding to meet the needs of the expanding bureaucracy
• Attack Death
• "Do you like to dance?" Aviendha asks
• Come on! Hit me! Conan O'Brien punched by Maria Menounos in the abs
• Almost monetized on YouTube
• How do you make God laugh?
• Step outside the world's tallest building
• Dune: Part 2 - Riding the sandworm
• Anytime you say "algorithm" replace it with "audience"
• Who did you fire? Senator drills Mark Zuckerberg, CEO of Facebook
• And our son?
• Great Wall of China - Civ4
• Elvis actor cast as Harkonnen Feyd-Rautha
• End of work from home #funny
• Egwene vs Ishamael - Wheel of Time
• Use a lifeline - Call my parents
• 10-year anniversary of Freedom!
• See the color changes
• All Heartbeat Photos features - No fluff
• Everyone shooting at Wonder Woman
• Drink a spicy margarita, make some bad decisions
• All Heartbeat features - No fluff
• Sexy squeeze through a narrow gap
• Graduation day
• Heartbeat Payday #2 ❤️
• Electric desk in action
• Dragon flies in