Java Chatter and Random Nagging

Thursday, December 07, 2006

Writing Java Doc

One of the rules the great book Effective Java Programming Language Guide mentions, is to write doc comments for all exposed API elements. Since I have difficulties remembering all the specific conventions considering this rule, I find Sun's How To Write Doc Comments very useful. In my personal opinion there is absolutely no valid excuse to NOT write doc comments for all your public methods and classes.


Post a Comment

<< Home