Heh, fire away!<div><br></div><div>Oenology is intentionally over-commented (if anything), given that, at the end of the day, its underlying purpose is to be a teaching tool. That said, while I would probably pare down on the inline documentation somewhat if I were optimizing for end-use, I wouldn't cut out all that much. I've really grown to appreciate the usefulness of phpDoc.</div>
<div><br></div><div>Chip<br><br><div class="gmail_quote">On Tue, Jul 5, 2011 at 9:42 AM, Edward Caissie <span dir="ltr"><<a href="mailto:edward.caissie@gmail.com">edward.caissie@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
@Mike -<br><br>Not to point any fingers or anything (@Chip ... duck); have you had a look at the Oenology Theme?<br><br>Now there is documentation, perhaps not in the same vein as what you have in mind but something to consider when looking at a code to comment ratio.<br>
<br><br>Cais.<br><br>PS: I'm not knocking the documentation of the existing theme or the proposed one, I've always believed the better the documentation the better the code. EAC.<div><div></div><div class="h5"><br>
<br><div class="gmail_quote">On Tue, Jul 5, 2011 at 9:46 AM, Michael Fields <span dir="ltr"><<a href="mailto:michael@mfields.org" target="_blank">michael@mfields.org</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div style="word-wrap:break-word"><div>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 :)</div>
<br><div><div><div></div><div><div>On Jul 5, 2011, at 6:32 AM, scribu wrote:</div><br></div></div><blockquote type="cite"><div><div></div><div>Michael, if 50% of the file is made up of comments, then you might be doing something wrong. See:<br>
<br><a href="http://www.codinghorror.com/blog/2008/07/coding-without-comments.html" target="_blank">http://www.codinghorror.com/blog/2008/07/coding-without-comments.html</a><br>
<br>-- <br><a href="http://scribu.net/" target="_blank">http://scribu.net</a><br></div></div><div>
_______________________________________________<br>theme-reviewers mailing list<br><a href="mailto:theme-reviewers@lists.wordpress.org" target="_blank">theme-reviewers@lists.wordpress.org</a><br><a href="http://lists.wordpress.org/mailman/listinfo/theme-reviewers" target="_blank">http://lists.wordpress.org/mailman/listinfo/theme-reviewers</a><br>
</div></blockquote></div><br></div><br>_______________________________________________<br>
theme-reviewers mailing list<br>
<a href="mailto:theme-reviewers@lists.wordpress.org" target="_blank">theme-reviewers@lists.wordpress.org</a><br>
<a href="http://lists.wordpress.org/mailman/listinfo/theme-reviewers" target="_blank">http://lists.wordpress.org/mailman/listinfo/theme-reviewers</a><br>
<br></blockquote></div><br>
</div></div><br>_______________________________________________<br>
theme-reviewers mailing list<br>
<a href="mailto:theme-reviewers@lists.wordpress.org">theme-reviewers@lists.wordpress.org</a><br>
<a href="http://lists.wordpress.org/mailman/listinfo/theme-reviewers" target="_blank">http://lists.wordpress.org/mailman/listinfo/theme-reviewers</a><br>
<br></blockquote></div><br></div>