Ever wonder how web designers keep everything in order when they’re typing out their code? Well, commenting helps a lot in organizing. By using comments, you can also signal out things you want to fix, make note of, or even just keep track of. So how do you keep the comments from messing up the 18 hours of coding you just did? Well, there are different options for different languages.
HTML
Below is the style for your basic html web page which really shouldn’t have too many comments- just nice clean code.
<!-- Comment Here -->
CSS
For organizing your styles and your main boxes- or whatever else you need- this commenting style works for single line or block quotes.
/* Comment Here */
JavaScript or jQuery
For JavaScript or jQuery, this method comments out the entire line starting from behind the back slashes. It is used as an end of line comment. CSS style is used as a short single line comment.
// Comment Here /* Comment Here */
For block comments the code looks like CSS, but remember to keep an asterisk on each line.
/* * Comment Here */
PHP
PHP can use the JavaScript method, or the pound symbol to comment out a line.
// Comment Here # Comment Here
For multiple lines, the comment code is like the CSS code but unlike the JavaScript, no further asterisks are needed.
/* Comment Here */
Ajax
To comment in Ajax, use the same method as in JavaScript.
// Comment Here
ActionScript
When working with flash, you might want to use these to comment on your action script. The first works for multiple lines and single lines while the second is just used for single lined short comments.
/* Comment Here */ // Comment Here
