Code cleanliness (3)

Note

1. Comments cannot beautify bad code
2. Use code to describe your ideas
3. What is a good comment?
1. Legal information
2. Provide information comments
3. Explanation of intent
4. Warning: for example, // don't run unless you have some time to kill
5. Todo comments
6. Javadoc for public APIs
4. What are bad comments?
1. Additional comments
2. Misleading comments
3. Track-based annotation: It is silly to say that every function requires javadoc to live and every variable requires annotations. Such annotations can only make the code messy.
4. Log Annotation
5. Nonsense comment: default constructor
6. Too much information: Do not write anything in comments, and write all the details... My God.

Error Handling

1. Use uncontrollable exceptions whenever possible
2. Environment Description of exceptions
3. Do not return NULL values
4. Do not pass null values