tag:blogger.com,1999:blog-25340877.post7750864974270944690..comments2018-06-27T15:48:03.132-07:00Comments on the ramblings of a .net dude: How To Write Self-Documenting CodeAnonymoushttp://www.blogger.com/profile/07645289431023957896noreply@blogger.comBlogger2125tag:blogger.com,1999:blog-25340877.post-7010882652515143392008-12-05T12:24:00.000-07:002008-12-05T12:24:00.000-07:00@Anonymous:You're right: the n00b comments are goo...@Anonymous:<BR/><BR/>You're right: the n00b comments are good for the n00b; he needs them in order to understand what he's doing. To some extent it's the same thing small children do: they talk about the action they are performing in order to help them make sense out of them.<BR/><BR/>I don't think methods always need comments, but doc headers are definitely a good idea for automating automating your documentation.<BR/><BR/>Thanks for taking the time to comment.Anonymoushttps://www.blogger.com/profile/07645289431023957896noreply@blogger.comtag:blogger.com,1999:blog-25340877.post-59347355304071924632008-12-02T17:09:00.000-07:002008-12-02T17:09:00.000-07:00Hah, yr my grader. I think the noob comments are ...Hah, yr my grader. <BR> <BR/>I think the noob comments are good for the noob. Perhaps he's never coded in Java before, nor has he ever connected to a database via Java. So he wants to be able to look at his own code and find out what's going on.<BR><BR/>In the code you describe as very fine, the coder leaves method calls as self-explanatory. They are, they're descriptively named. However, don't each of those methods need the JavaDoc header? Methods need comments, thats just the way it goes.<BR><BR/>The point you make about methods is important. Thanks for your tips. :)Anonymousnoreply@blogger.com