X-Cart forums

[Mike SSI]

Which is a better approach when customizing a template file?
A. Comment out {* *} unused code.
B. Remove unused code completely.

I've always commented out unused code for a couple reasons. First, I may want to reuse the code at a later date and second, I thought it causes less issues when patching and upgrading templates.

What does everyone else do?

[totaltec]

Its a good question, I can't say that I stick to one method or the other, it depends on the setup and situation.

If I am working in a custom skin directory (which I highly recommend you do), then I just remove the code. In this case /common_files has a backup so I don't need to worry about losing the original code. With the unnecessary code gone, the template reads much easier.

While I am working out a solution, I usually comment out pieces temporarily as I am determining their function and usefulness. After I'm finished I remove the commented out pieces.

Now If I am just making a quick fix or edit, and not creating a custom skin, I always simply comment out and make notes to my change.

[cflsystems]

Comment it out. While deleting it may look like a cleaner solution leaving the code in there commented out will not hurt and as you said - it is there if you need it later. Smarty completely ignores anything commented out and it does not show in the html code as well. And use smarty comments {* *} not html comments <!-- -> - html comments will show in final html code.

[Steel]

If a merchant never intends to utilize a module like the Bill Me Later Financing module, you suggest that commenting it out on the tpl file would be best practice. If the number of modules not being utilized was significant, would there be any benefit to removing the specifically related code from CSS and/or PHP files?

[carpeperdiem]

A good practice is to NOT edit the code in common_files ever - instead apply the technique that Mike discusses in his video:

http://www.youtube.com/watch?v=5nkd7FPHMdA

I typically will comment the daylights out of my templates -- because you just may revisit something a few years from now and you will think, "WTF was the coder thinking?" -- but I can see in the comments that I was the freaking idiot that did this...

Where this technique becomes messy is if you are purchasing 3rd party mods -- and the 3rd party wants common_files template edits. SO you have to work around that.

The idea that "I'll leave the commented out code in-place just in case of a future upgrade" is a myth. If you're upgrading, you are starting from scratch with new core. Your edits may or may not be useful. But the idea that you can upgrade any template file that's been well modified or commented out is, well, fantasy. It doesn't really matter what you do to the templates.

NOW -- php files -- comment the daylights out of them too... but like templates, all the commenting in the world will not solve your upgrade challenge if you ever upgrade. But commented files are better than nothing.

Good luck!