Class DocumentedHelloWorld

java.lang.Object
  |
  +--DocumentedHelloWorld

Direct Known Subclasses:

Test

public class DocumentedHelloWorld

extends java.lang.Object

--- DOCUMENTATION COMMENTS begin with '/**'. --- Documentation comments FACE THE DEFINITIONS of: classes, interfaces, members(methods and variables) --- SPECIAL TAGS prefixed by the 'at' symbol '@' contain additional information or even links in the remaining part of the line:

Field Summary

(package private) static int

i A four-byte class-variable of type integer.

Constructor Summary

DocumentedHelloWorld()

Method Summary

static void	main(java.lang.String[] args) Only for methods are meant the three tags "@param", "@return" and "@exception".
(package private) void	oldVersion() Deprecated.

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Field Detail

i

static int i

A four-byte class-variable of type integer.

Constructor Detail

DocumentedHelloWorld

public DocumentedHelloWorld()

Method Detail

oldVersion

void oldVersion()

Deprecated.

A method that maybe used by existing code, but shouldn't be used by newly written code. The "@deprecated" tag marks only classes and members.

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Only for methods are meant the three tags "@param", "@return" and "@exception".

Parameters:

args - String-constants given when running the program

Returns:

returns nothing, because declared 'void'

Throws:

java.lang.Exception - thrown by the method plus a closer description that can comprise multiple lines. The following generates a hyperlink if the class-name is known and the API documentation is in the CLASSPATH????

See Also:

String, java.lang.System