Tag Archives: comments

Eliminate Useless Comments

Posted on October 18, 2019 by keith swenson

Be careful what you ask for.   I was reviewing some code that had absolutely no comments. I asked the developer to add some comment.   So, indeed they did, however the comments added no value to the code at all.   There … Continue reading →

Posted in Coding, practice | Tagged , , , , | Leave a comment

#10 Indicate what happens when function can't return value

Posted on October 10, 2011 by keith swenson

There are many functions which take a value, go and look for something, and return an object. If the object is found it is returned, but if it is not found, what do you do?  There are two possibilities, either … Continue reading →

Posted in Coding | Tagged , , , | Leave a comment

#1 Don't make content-free comments

Posted on September 29, 2011 by keith swenson

Avoid the inclusion of “content-free java-doc”. This means that a Java-Doc header is created that has no information content in there. Comments in general should have useful information that is not obvious, or there should be no comment at all.

Posted in Coding | Tagged | Leave a comment