Pr

ogr
ammi
ngSt
yleandDocument
ati
on

Goodpr
ogr
ammi
ngst
yleandpr
operdocument
ati
onmakeapr
ogr
am easyt
oreadand

hel
ppr
ogr
ammer
spr
eventer
ror
s.

Pr
ogr
ammi
ngst
yledeal
swi
thwhatpr
ogr
amsl
ookl
i
ke.Apr
ogr
am cancompi
l
eandr
un

pr
oper
lyev
eni
fwr
it
tenononl
yonel
i
ne,
butwr
it
ingi
tal
lononel
i
newoul
dbeabadpr
o-

gr
ammi
ngst
ylebecausei
twoul
dbehar
dtor
ead.Document
ati
oni
sthebodyofexpl
anat
ory

r
emar
ksandcomment
sper
tai
ningt
oapr
ogr
am.Pr
ogr
ammi
ngst
yleanddocument
ati
onar
e

asi
mpor
tantascodi
ng.Goodpr
ogr
ammi
ngst
yleandappr
opr
iat
edocument
ati
onr
educet
he

chanceofer
ror
sandmakepr
ogr
amseasyt
oread.Thi
ssect
iongi
vessev
eral
gui
del
i
nes.

Formor
edet
ail
edgui
del
i
nes,
seeSuppl
ementI
.C,
Jav
aCodi
ngSt
yleGui
del
i
nes,
ont
he

Compani
onWebsi
te.

1.
9.1Appr
opr
iat
eComment
sandCommentSt
yles

I
ncl
udeasummar
yatt
hebegi
nni
ngoft
hepr
ogr
am t
hatexpl
ainswhatt
hepr
ogr
am does,
itskey
f
eat
ures,
andanyuni
quet
echni
quesi
tuses.I
nal
ongpr
ogr
am,
youshoul
dal
soi
ncl
udecom-

ment
sthati
ntr
oduceeachmaj
orst
epandexpl
ainany
thi
ngt
hati
sdi
ff
icul
ttor
ead.I
tis
i
mport
ant

t
omakecomment
sconci
sesot
hatt
heydonotcr
owdt
hepr
ogr
am ormakei
tdi
ff
icul
ttor
ead.

I
naddi
ti
ont
oli
necomment
s(begi
nni
ngwi
th/
/)andbl
ockcomment
s(begi
nni
ngwi
th/
*),

Jav
asuppor
tscomment
sofaspeci
alt
ype,
ref
err
edt
oasj
avadoccomment
s.j
avadoccom-

ment
sbegi
nwi
th/
**andendwi
th*
/.Theycanbeext
ract
edi
ntoanHTMLf
il
eusi
ngt
he

JDK’
sjav
adoccommand.Formor
einf
ormat
ion,
seeSuppl
ementI
II
.X,
jav
adocComment
s,

ont
heCompani
onWebsi
te.

Usej
avadoccomment
s(/
**...*
/)f
orcomment
ingonanent
ir
ecl
assoranent
ir
e

method.Thesecomment
smustpr
ecedet
hecl
assort
hemet
hodheaderi
nor
dert
obe
ext
ract
edinto

aj
avadocHTMLf
il
e.Forcomment
ingonst
epsi
nsi
deamet
hod,
usel
i
necomment
s(/
/).Tosee

anexampl
eofaj
avadocHTMLf
il
e,checkoutl
i
veexampl
e.pear
soncmg.
com/
jav
adoc/
Exer
cise1.
ht
ml.I
tscorr
espondi
ngJavacodeisshownin
l
iv
eexample.
pear
soncmg.com/j
avadoc/
Exer
cise1.
txt
.