Skip to content

piloulac/clean-code

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 

Repository files navigation

Clean Code - Robert C. Martin Series

Clean Code is divided into three parts. The first describes the principles, patterns, and practices of writing clean code. The second part consists of several case studies of increasing complexity. Each case study is an exercise in cleaning up code. Transforming a code base that has some problems into one that is sound and efficient. The third part is the payoff: a single chapter containing a list of heuristics gathered while creating the case studies. The result is a knowledge base that describes the way we think when we write, read, and clean code.

"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."

"Why do clean code? Because code will be written once, but read a hundred times."

General rules

  1. Follow standard conventions.
  2. Keep it simple stupid. Simpler is always better. Reduce complexity as much as possible.
  3. Boy scout rule. Leave the campground cleaner than you found it.
  4. Always find root cause. Always look for the root cause of a problem.

Content

  1. Meaningful names
  2. Functions
  3. Comments
  4. Error handling
  5. Understandability tips
  6. Source code structure

External Resources

Those articles were written by me 2 years ago, they express my own experience of not writing clean code. Be easy :)

  1. Article: Clean code matters, a lot
  2. Article: Tests are not optionals

If you want to enjoy your job for life. Please follow those guidelines. ;)

About

Clean Code Robert C. Martin Series

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published