re: Don't document your code. Code your documentation. VIEW POST


There some cases where I like to put a short summary at the top of a class indicating what it's supposed to do, or what the scope is. Especially if (the name of) the class bears no reference to some familiar pattern in the team.

And I'm all for proper naming and method extraction to avoid comments.

code of conduct - report abuse