[theme-reviewers] Heavily Commented Javascript Files.

Michael Fields michael at mfields.org
Tue Jul 5 13:46:11 UTC 2011

Possibly, but that's a matter of opinion. Personally, I find that undocumented code is harder to maintain in the long run. I definitely do not agree with that article though as the "docblock" style example is a bit over-the-top while the function most-likely does not need to be documented. Everything in-between is not covered. For me, documentation serves as a record of intention. If the words do not match the code, it is easier for me or someone else to debug. I love it! You can't make me stop :)

On Jul 5, 2011, at 6:32 AM, scribu wrote:

> Michael, if 50% of the file is made up of comments, then you might be doing something wrong. See:
> http://www.codinghorror.com/blog/2008/07/coding-without-comments.html
> -- 
> http://scribu.net
> _______________________________________________
> theme-reviewers mailing list
> theme-reviewers at lists.wordpress.org
> http://lists.wordpress.org/mailman/listinfo/theme-reviewers

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.wordpress.org/pipermail/theme-reviewers/attachments/20110705/34305afa/attachment.htm>

More information about the theme-reviewers mailing list