Difference between revisions of "Comments"
(reword overview) |
(→Example of a Java Program with Comments: reword introduction) |
||
| Line 2: | Line 2: | ||
=Example of a Java Program with Comments= | =Example of a Java Program with Comments= | ||
| − | Take a look at the example below. | + | Take a look at the example below. You will notice that some of the text does not look like Java code - they are normal English sentences. Since Java will not understand these sentences, we use certain characters to denote that sections of text are '''comments'''. |
| + | |||
| + | If we want to include a comment that is longer than one line, we put <code>/*</code> at the beginning of the comment and <code>*/</code> at the end. | ||
| + | |||
| + | If we want to include a comment on only one line, we use <code>//</code>. The text that appears after <code>//</code> is a comment. | ||
<pre> | <pre> | ||
| Line 29: | Line 33: | ||
} | } | ||
</pre> | </pre> | ||
| − | |||
| − | |||
When a program is compiled, the compiler ignores the comments. This means that comments do not affect the program. So, why do we use comments? Comments are only for you and any one else that reads your source code. To see the value of comments, imagine someone gives you the source code to a long, complex program which does not contain any comments. If you wanted to understand the code you would have to spend a lot of time going through each line and figuring out what everything does. However, if this program had comments that explained the purpose of each class, method, and block of code, it would make understanding the code a lot easier. | When a program is compiled, the compiler ignores the comments. This means that comments do not affect the program. So, why do we use comments? Comments are only for you and any one else that reads your source code. To see the value of comments, imagine someone gives you the source code to a long, complex program which does not contain any comments. If you wanted to understand the code you would have to spend a lot of time going through each line and figuring out what everything does. However, if this program had comments that explained the purpose of each class, method, and block of code, it would make understanding the code a lot easier. | ||
Revision as of 14:26, 2 December 2007
COMP 1010 Home > Java Fundamentals
|
IntroductionWe can add comments to our source code to improve organization and to help someone else understand what our code does.
|
|---|
{{{Body}}}
Example of a Java Program with Comments
Take a look at the example below. You will notice that some of the text does not look like Java code - they are normal English sentences. Since Java will not understand these sentences, we use certain characters to denote that sections of text are comments.
If we want to include a comment that is longer than one line, we put /* at the beginning of the comment and */ at the end.
If we want to include a comment on only one line, we use //. The text that appears after // is a comment.
/**
* PrintTemp
*
* This program shows you how to print the contents of a variable
*
* COMP 1010
* Instructor: Compsci Wiki
* Assignment: Assignment 0, question 0
* @author Compsci Wiki
* @version
*/
public class PrintTemp
{
public static void main(String args[])
{
int temp; //declare an variable of type integer
temp = 25; //store 25 in a variable
System.out.println("The temperature is currently " + temp + " degrees Celsius."); //print the temperature to the screen
}
}
When a program is compiled, the compiler ignores the comments. This means that comments do not affect the program. So, why do we use comments? Comments are only for you and any one else that reads your source code. To see the value of comments, imagine someone gives you the source code to a long, complex program which does not contain any comments. If you wanted to understand the code you would have to spend a lot of time going through each line and figuring out what everything does. However, if this program had comments that explained the purpose of each class, method, and block of code, it would make understanding the code a lot easier.
