|
Making comments in your source code |
|
Commenting is absolutely necessary when programming. It's useful to you because you won't forget what you were doing or thinking at that time. But it's expecially useful for others because they'll know how to work with your code.
Every programming language has it's own way of making comments, which can be very annoying. Never had that you were making Java comments on your HTML page? Here's a small list of some programming languages with their way of commenting. Alltough CSS, HTML and MySQL aren't real programming languages, I posted them in this list because it can be useful for webdesigners.
Take note that there could be more ways to comment your code. Just make sure you pick one universal type in all your code.
Actionscript
Single line comment:
// Comments
Multiline comment:
/**
* Comments line one
* Comments line two
**/
C++
Inline comment:
// Comments
Single line comment:
/* Comments */
Multiline comment:
/*
* Comments line one
* Comments line two
*/
CSS
Commenting:
/* Comments */
Delphi
Single line comment:
// Comments
Multiline comment:
{
Comments line one
Comments line two
}
HTML / XHTML / XML
Commenting:
<!-- Comments -->
Java
Single line comment:
// Comments
Multiline comment:
/**
* Comments line one
* Comments line two
**/
MySQL
Single line comment:
-- Comments
Multiline comment:
--
-- Comments line one
-- Comments line two
--
PHP
Single line comment:
// Comments
Multiline comment:
/*
# Comments line one
# Comments line two
*/
Tags: useful tips comments programming programming languages
Interested in this topic? You might enjoy another article I've written called
Spread the word and submit to:
       
|