Untitled.Bat |
Developer, dad & dangerously dopey.....Also awesome at alliteration and assonance . Visit my main website @ http://www.xerxesb.com if you're tech-inclined |
C1: Inappropriate Information - It is inappropriate for a comment to hold information better held in different kinds of systems such as source-control, issue tracking or other forms of record keeping. Comments should be reserved for technical notes about the code design.
C2: Obsolete Comment - Comments get old quickly. It is best not to write a comment which will become obsolete as they float away from the code once described and become islands of irrelevance and misdirection.
C3: Redundant Comment - A comment which describes something that adequately describes itself. eg: i++; // Increment i
C4: Poorly Written Comment - If it’s worth writing, it’s worth writing well. Choose your words carefully and use correct punctuation and grammar. Don’t ramble Be brief
C5: Commented Out Code - This code sits and rots, getting less and less relevant every day. It calls functions that no longer exist, uses variables whose names have changed and follows out-dated conventions. Just delete it! your source-control system will still remember it.
Clean Code: Chapter 17
