Comments in rendered page?

Monday 29 September 2003 2:26:49 am

I think you can comment lines in standard HTML mode
<!-- -->

By this way ezp should pass the html as it is and it should arrive to the browser...

I have never tried it but it should work

Paolo

Monday 29 September 2003 8:35:30 am

The {* *} comment tags are meant to be used when developing template files, *not* for being viewed in the html source.

I shouldn't need to what the value of comments are to a developer. If you have written some complex template code and pass it over to another developer it takes a lot longer to decipher what the code does if there are no comments in there.

paul

Tuesday 30 September 2003 7:54:17 am

I often use server-side comments like {* *} (or in PHP /* */ ) when I want to leave notes for other developers or myself. There might be notes about sensitive parts of the code that I don't want exposed to the user or descriptions of logic that is rendered before it ever gets to the browser.

In general, I think standard HTML comments should be used sparingly as they do the user little to no good. They add additional weight to the page which can add up over time. If I need to see what template is loaded then a temporary HTML comment works, but if I want to keep track of what the code is doing in a template, then server-side comments are ideal.

My thoughts,

Alex

Alex
[ bald_technologist on the IRC channel (irc.freenode.net): #eZpublish ]

<i>When in doubt, clear the cache.</i>

Tuesday 30 September 2003 8:12:38 am

This boils down to best practice for coding web pages. Each different view can be right and wrong depending on your circumstances.

From my own point of view working with many projects i heavily re-use my own templates. Coming back to something a few days/weeks/months old can be made very easy by commenting code properly. Since the end user can *never* see {* *} comments I can write comments as i like.

I also work with my servers in a local environment, testing the code in several ways, on-screen feedback, using 'tail -f' var/log/*.log, etc. Only if there is a problem would i need to turn on debugging on a live site.

It may one day be possible to use a proper documentor ala doxygen,javadoc to parse the ez template code in some useful way... Not sure how useful but i like programs that create documentation for me in a structured manner.

These points work well in a multi-project environment. Almost essential. But for a small number it probably isn't necessary.

I consider myself a software engineer given my background and i've come to rely on certain best practices when it comes to code.

Paul