Java

Java

// /* */ /** */

Java

javadoc HTML

javadoc

javadoc

@author @author description
@deprecated @deprecated description
{@docRoot} Directory Path
@exception @exception exception-name explanation
{@inheritDoc} Inherits a comment from the immediate surperclass.
{@link} {@link name text}
{@linkplain} Inserts an in-line link to another topic.
@param @param parameter-name explanation
@return @return explanation
@see @see anchor
@serial @serial description
@serialData writeObject( )  writeExternal( ) @serialData description
@serialField ObjectStreamField @serialField name type description
@since @since release
@throws @exception. The @throws tag has the same meaning as the @exception tag.
{@value} static Displays the value of a constant, which must be a static field.
@version @version info

/**

@ @ *

@see

/*** * @author runoob * @version 1.2 */

javadoc

javadoc Java HTML

HTMLjavadoc

javadoc Java Javadoc

javadoc SquareNum SquareNum.html

SquareNum.java

import java.io.*; /** * * @author Ayan Amhed * @version 1.2 */ public class SquareNum { /** * This method returns the square of num. * This is a multiline description. You can use * as many lines as you like. * @param num The value to be squared. * @return num squared. */ public double square(double num) { return num * num; } /** * This method inputs a number from the user. * @return The value input as a double. * @exception IOException On input error. * @see IOException */ public double getNumber() throws IOException { InputStreamReader isr = new InputStreamReader(System.in); BufferedReader inData = new BufferedReader(isr); String str; str = inData.readLine(); return (new Double(str)).doubleValue(); } /** * This method demonstrates square(). * @param args Unused. * @return Nothing. * @exception IOException On input error. * @see IOException */ public static void main(String args[]) throws IOException { SquareNum ob = new SquareNum(); double val; System.out.println("Enter value to be squared: "); val = ob.getNumber(); val = ob.square(val); System.out.println("Squared value is " + val); } }

javadoc SquareNum.java 

$ javadoc SquareNum.java
Loading source file SquareNum.java...
Constructing Javadoc information...
Standard Doclet version 1.5.0_13
Building tree for all the packages and classes...
Generating SquareNum.html...
SquareNum.java:39: warning - @return tag cannot be used\
                      in method with void return type.
Generating package-frame.html...
Generating package-summary.html...
Generating package-tree.html...
Generating constant-values.html...
Building index for all the packages and classes...
Generating overview-tree.html...
Generating index-all.html...
Generating deprecated-list.html...
Building index for all classes...
Generating allclasses-frame.html...
Generating allclasses-noframe.html...
Generating index.html...
Generating help-doc.html...
Generating stylesheet.css...
1 warning
$