cd /news/developer-tools/summary-of-clean-code-by-robert-c-ma… · home topics developer-tools article
[ARTICLE · art-12638] src=gist.github.com ↗ pub= topic=developer-tools verified=true sentiment=↑ positive

Summary of 'Clean code' by Robert C. Martin

The article summarizes Robert C. Martin's principles for writing "clean code," which is code that is easily understood, read, and enhanced by any developer on a team. It lists numerous specific practices, such as following standard conventions, keeping code simple, applying the Boy Scout rule, and preferring polymorphism over conditionals. The summary also identifies common code "smells" that indicate poor design, including rigidity, fragility, and needless complexity.

read3 min views20 publishedOct 8, 2016

Code is clean if it can be understood easily – by everyone on the team. Clean code can be read and enhanced by a developer other than its original author. With understandability comes readability, changeability, extensibility and maintainability.

  • Follow standard conventions.
  • Keep it simple stupid. Simpler is always better. Reduce complexity as much as possible.
  • Boy scout rule. Leave the campground cleaner than you found it.
  • Always find root cause. Always look for the root cause of a problem.
  • Keep configurable data at high levels.
  • Prefer polymorphism to if/else or switch/case.
- Separate multi-threading code.
- Prevent over-configurability.
  • Use dependency injection.
  • Follow Law of Demeter. A class should know only its direct dependencies.
  • Be consistent. If you do something a certain way, do all similar things in the same way.
  • Use explanatory variables.
  • Encapsulate boundary conditions. Boundary conditions are hard to keep track of. Put the processing for them in one place.
  • Prefer dedicated value objects to primitive type.
  • Avoid logical dependency. Don't write methods which works correctly depending on something else in the same class.
  • Avoid negative conditionals.
  • Choose descriptive and unambiguous names.
  • Make meaningful distinction.
  • Use pronounceable names.
  • Use searchable names.
  • Replace magic numbers with named constants.
  • Avoid encodings. Don't append prefixes or type information.
  • Small.
  • Do one thing.
  • Use descriptive names.
  • Prefer fewer arguments.
  • Have no side effects.
  • Don't use flag arguments. Split method into several independent methods that can be called from the client without the flag.
  • Always try to explain yourself in code.
  • Don't be redundant.
  • Don't add obvious noise.
  • Don't use closing brace comments.
  • Don't comment out code. Just remove.
  • Use as explanation of intent.
  • Use as clarification of code.
  • Use as warning of consequences.
  • Separate concepts vertically.
  • Related code should appear vertically dense.
  • Declare variables close to their usage.
  • Dependent functions should be close.
  • Similar functions should be close.
  • Place functions in the downward direction.
  • Keep lines short.
  • Don't use horizontal alignment.
  • Use white space to associate related things and disassociate weakly related.
  • Don't break indentation.
  • Hide internal structure.
  • Prefer data structures.
  • Avoid hybrids structures (half object and half data).
  • Should be small.
  • Do one thing.
  • Small number of instance variables.
  • Base class should know nothing about their derivatives.
  • Better to have many functions than to pass some code into a function to select a behavior.
  • Prefer non-static methods to static methods.
  • One assert per test.
  • Readable.
  • Fast.
  • Independent.
  • Repeatable.
  • Rigidity. The software is difficult to change. A small change causes a cascade of subsequent changes.
  • Fragility. The software breaks in many places due to a single change.
  • Immobility. You cannot reuse parts of the code in other projects because of involved risks and high effort.
  • Needless Complexity.
  • Needless Repetition.
  • Opacity. The code is hard to understand.
── more in #developer-tools 4 stories · sorted by recency
── more on @robert c. martin 3 stories trending now
sponsored brought to you by zahid.host 4,200+ EU-deployed projects
reading about agents? ship yours in a single git push.

Run your AI side-project on zahid.host

EU-based hosting, git-push deploys, automatic HTTPS, no cold starts. Free tier with a custom domain — perfect for shipping the agent you just read about.

$git push zahid main
Live at https://your-agent.zahid.host
Get free account → Pricing
from €0/mo · no card required
LIVE [news/summary-of-clean-cod…] indexed:0 read:3min 2016-10-08 ·