Javadoc

LA home
Computing
 Algorithms
 Bioinformatics
 FP,  λ
 Logic,  π
 MML
 Prog.Langs

ProgLang
 glossary
 Java
  Javadoc
/** magic <I>doc comment</I> ... is in HTML ... [tag-section] */
goes immediately before a class, method or variable declaration.
 
The most useful and/or common tags
@param
param of method, or type param of class or method.
e.g., @param seq the DNA sequence to be analysed.
@return (of a method)
@see
@see [[package.]class]#member [showThis]
(name shown if no text)
@see [package.]class [showThis],
e.g., see java.lang.Math
@see package [showThis]
@see <A HREF="URL#value">textToBeShown</a>
@throws (of a method)
. . .
 
In-line tag, {@inlineTag}
{@inheritDoc}
copy (~inherit) text from the superclass, overridden method, or implemented method spec. (of interface), as appropriate.
{@link [[package.]class]#member label}   (also see '@see'.-)
. . .
window on the wide world:

Computer Science Education Week

Linux
 Ubuntu
free op. sys.
OpenOffice
free office suite,
ver 3.4+

The GIMP
~ free photoshop
Firefox
web browser
FlashBlock
like it says!

Java
 API

From
[javadoc]

© L. Allison   http://www.allisons.org/ll/   (or as otherwise indicated),
Faculty of Information Technology (Clayton), Monash University, Australia 3800 (6/'05 was School of Computer Science and Software Engineering, Fac. Info. Tech., Monash University,
was Department of Computer Science, Fac. Comp. & Info. Tech., '89 was Department of Computer Science, Fac. Sci., '68-'71 was Department of Information Science, Fac. Sci.)
Created with "vi (Linux + Solaris)",  charset=iso-8859-1,  fetched Friday, 24-Oct-2014 23:44:19 EST.