Add a personal note in a php file

[mcpisik]

Hi,
I'd simply (and cleanly) like to add a personal note when I attempt to edit a php file.

Eg.
// "I added the below code when trying to install xsell module"
require($template->get_template_dir('tpl_modules_xsell_products.php',

(the // is just a wild shot. What should I use that so the comment doesn't affect the code?)

Thanks

[schoolboy]

Yes... this COMMENTS OUT php code - but be aware that in many files, the php is interspersed with html markup.

You can use the // comment tags, when the strings you are working with are enclosed in:

<?php

code here...

?>

When it breaks to HTML, you use <!-- html here... -->

[mcpisik]

Ah perfect. That's why it hadn't worked for me a while back.
Thanks for explaining.

[swguy]

Also note that // is a single line comment. If you want multiline comments, you can enclose them in /* and */

/*
This is a
multiline
comment
*/

is the same as

// This is a
// multiline
// comment