[question] in-line comments

For a while, I’ve wondered how to be able to leave comments in chunks, document content, templates etc, without resorting to <!-- this --> as I’m not crazy about polluting the html output with development notes especially on a production site.

Today I did the following to hide or comment-out a Wayfinder call.


I know there are several ways to hide stuff, but I like this approach because it reuses my php and javascript habits. My question is, are there any drawbacks to that technique, other than a little document parser overhead looking for a snippet that’s not there?

I’d also do stuff like this:


I know it will work but I’m just wondering if this is a *bad idea* in anyone’s opinion.

Is the answer the same for 0.9.6 and Revolution?

Cheers

Good trick. I often will just put a space in the middle of a snippet name to disable it but I like the double-slash method better.

I also use spaces or using a snippet name that does not exist like [[note: some text here]] or [[todo: some text here]]. The only down thing is that I think modx will try to parse this snippet and it will fail and move on. So some server resources are being used.

I might amend my method to include the // to make it easier to spot.

This is a nice tip!, its like hidden comments and they are kept in the cms only.

My only concern:

It seems logical but I mention this as an issue because it’s easy to take into account. Try to avoid the following character combinations in your template if they are not part of a MODx tag:

http://wiki.modxcms.com/index.php/PHx#Known_issues


//This was just placeholders though and not the snippet brackets, and by
closing it gets an MODx tag! Awesome!