... | ... | @@ -44,6 +44,17 @@ public SellResponse beginSellitem(SellRequest sellRequest) |
|
|
Comments should say things that the code cannot say for itself.
|
|
|
|
|
|
|
|
|
#### C4: Poorly Written Comment
|
|
|
|
|
|
A comment worth writing is worth writing well. If you are going to write a comment take the time to make sure it is the best comment you can write. Choose your words carefully. Use correct grammar and punctuation. Don't ramble. Don't state the obvious. Be brief.
|
|
|
|
|
|
#### C5: Commented-Out Code
|
|
|
|
|
|
It makes me crazy to see stretches of code that are commented out. Who knows how old it is? Who knows whether or not it's meaningful? Yet no one will delete it because everyone assumes someone else needs it or has plans for it.
|
|
|
|
|
|
That code sits there and rots, getting less and less relevant with every passing day. It calls functions that no longer exist. It uses variables whose names have changed. It follows conventions that are long obsolete. It pollutes the modules that contain it and distracts the people who try to read it. Commented-out code is an abomination.
|
|
|
|
|
|
When you see commented-out code, delete it! Don't worry, the source code control system still remembers it. If anyone really needs it, he or she can go back and check out a previous version. Don't suffer commented-out code to survive.
|
|
|
|
|
|
|
|
|
|
... | ... | |