how to comment java code example
Example 1: java what are the comments before a method
/**
* Returns an Image object that can then be painted on the screen.
* The url argument must specify an absolute <a href="#{@link}">{@link URL}</a>. The name
* argument is a specifier that is relative to the url argument.
* <p>
* This method always returns immediately, whether or not the
* image exists. When this applet attempts to draw the image on
* the screen, the data will be loaded. The graphics primitives
* that draw the image will incrementally paint on the screen.
*
* @param url an absolute URL giving the base location of the image
* @param name the location of the image, relative to the url argument
* @return the image at the specified URL
* @see Image
*/
public Image getImage(URL url, String name) {
try {
return getImage(new URL(url, name));
} catch (MalformedURLException e) {
return null;
}
}
Example 2: comment in java
//This is single line comment
/*
This is
multi line comment
*/
Example 3: comments in java
// single line comment example
// integer variable 'a' is assigned value 5
int a = 5;
/*
This is
an example for
java multiline comment
*/
// Documentation comments example
/**
* <h1>Area of Square</h1>
* Area of Square java program calculates area
* using given side value and prints the area.
* <p>
* <b>Note: Adding comments in a java program makes it more
* user friendly and is presumed as good quality code
*
* @author Sachin
* @version 1.0
* @since 2015-04-12
* </b>
* </p>
*/