Comments

Java has comment conventions similar to those of C++. Two slashes together, “//” make the rest of the line a comment, as follows:

i = 0;  // the "to end-of-line" comment

Comments starting with “/*” make all the characters up to and including the first “*/”, be a comment. It might stretch over several lines:

/* the "regular multiline" comment
   goes here.
 */

Commenting out code

Since comments do not nest in Java, to comment out a big section of code, you must either put “//” at the start of every line, or use “/*” at the front and immediately after every embedded closing comment, finishing up with your own closing comment at the end.

You can also use the following around statements you want to temporarily delete:

if ( false ) {
    ...
}

Each of these approaches has advantages and disadvantages. Perhaps the best way to remove unwanted code is to use a source code control system. Delete the code. If you later need to recover it, fallback to a previous revision that included the code.

Javadoc comments

There's a third variety of comment starting with “/**”. This indicates text that will be picked up from the source code by javadoc, an automatic HTML documentation generator. The entire Java API has been documented by putting these “/** ... */” comments in the source code, and running javadoc on it. The resulting run-time library HTML documentation is on the Sun website at java.sun.com. Before we describe the format of javadoc comments, let's describe the javadoc output that forms the API documentation.

..................Content has been hidden....................

You can't read the all page of ebook, please click here login for view all page.
Reset
18.189.171.125