[theme-reviewers] Rule Addition?

[Chip Bennett]

I think it isn't standard because there is no established consensus or
convention for its usage. I think there is no such consensus or convention
because there are too many valid ways to accomplish the same thing, and too
many opinions regarding the appropriateness of this particular method.

For example, I make extensive use of inline PHPdocs in Oenology:
https://github.com/chipbennett/oenology/blob/master/index.php

I don't think that additional HTML comments would add anything beneficial
to the extant inline documentation.

That said, one thing that *is* helpful - though it can also be done with
PHP rather than HTML comments - is indication of the CSS ID of closing
containers (such as <div id="content">), since the opening and closing
container tags are often found in different template-part files.


On Sat, Feb 2, 2013 at 9:12 AM, Aaron Nimocks <aaron_nimocks at yahoo.com>wrote:

> I haven't gave this complete thought yet but I would assume this has been
> brought up before so just wanted to know if it has or why we don't do this.
>
> From a support or even end user perspective I would absolutely love if
> each template file was required to have a comment for when it started and
> ended.  This way just viewing the source you can instantly tell which file
> it is in.  I really don't think it would require too much effort for theme
> submitters but I think it would make a great deal of difference for
> supporting these themes as well as allowing end users to have a method of
> finding which page to edit.
>
> Using something standard like
>
> <!-- TEMPLATE FILE footer.php Start -->
> <!-- TEMPLATE FILE footer.php End -->
>
> or for hooks
>
> <!-- TEMPLATE HOOK wp_footer Start -->
> <!-- TEMPLATE HOOK wp_footer End -->
>
> I just went through real quick and adding some on
> http://www.wpbum.com/how-to-get-jobs-on-odesk.html for just page template
> and only took a few minutes.  But by viewing the source code it makes it
> really easy to see where all the code is being generated from and where to
> go to edit.
>
> Why isn't something like this a standard?
>
> Aaron
>
> _______________________________________________
> 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/20130203/f5597f46/attachment-0001.htm>