Tölvumál - 01.04.1991, Blaðsíða 12

Apríl 1991
Athugasemdir og
hausar
Athugasemdir eru nauðsynlegur
þáttur í forritagerð. Skammt er
þö öfganna á milli og mikil hætta
á að athugasemdir verði annað-
hvort of stuttaralegar eða óþarfa
{============================
I Verkefni.....: Lýsandi nafn
I Eiganöi......:
I Úcgáfudagur..:
I Úcgáfunúmer..:
inga og verksvið. Einnig er
æskilegt að tilgreina víðværar
breytur, nöíh á töflum/skrám sem
notaðar eru, og undirforritasöfti,
sem ekki tilheyra verkeftninu
beint. (Sjá mynd 5)
Hausinn fyrir öll víðvær
undirforrit (kallanleg frá annarri
einingu) skal skrifa íhönnun, og
er mjög mikilvægt að hausnum
sé breytt ef hönnunin breytist í
forritunarfasa.
Athugasemdir sem eiga við
margar línur skal nota þegar
undirforrit verður of stórt til að
haus sé næganlegur. Æskilegt er
að hverri röklægri aðgerð (t.d. 5
- 10 línur) fylgi athugasemd,
sem brúi bilið fram að næstu
athugasemd. Dæmi um
athugasemd fyrir margar línur:
/*
| Athugasemd */
Verk.sviö.....: Lýsing á því sem forriciö gerir
Eir.ing Lýsing
Nafn einingar Lýsing á verksviöi einingar
YCri breycur...:
YCri Cilvísanir:
Mynd 5.
endurtekning á því sem forrita-
kóðinn segir. Lykilatriðið er að
athugasemdir eru til að einfalda
aðkomu í forritið sfðar, hvort
heldur er fyrir nýja menn eða þá
sem skrifuðu kóðann. Nýr maður
á að geta fylgt forritinu eftir með
því að lesa athugasemdir, og
vitað nákvæmlega hvað er verið
að gera.
Hverri forritaeiningu skal fylgja
haus sem lýsir verksviði forrita-
einingar, hver forritar, breyt-
ingarsögu o.fl. (sjá mynd 6).
Hverju undirforriti skal fylgja
staðlaður haus, sem skal líta út
þannig (sjá mynd 7).
Línuathugasemd skal nota þegar
útskýra þarf eina línu nánar, og
skal athugasemd þá vera aftast í
línunni (//Athugasemd). Varast
skal að ofnota línuathugasemdir,
því skynsamlegar nafngiftir á
breytuheitum eiga í flestum
tilfellum að nægja.
Skipta má athugasemdum í eftir-
talda þætti:
- Athugasemdir í haus undir-
forrits
- Athugasemdir sem eiga við
margar línur
- Línuathugasemdir
Hverju verkefni skal fylgja
staðlaður haus sem geyma skal
fremst í aðalforriti og lýsir mark-
miðum og uppbyggingu forrits.
Atriði sem koma skulu fram eru
eftirfarandi: Heiti verkefnis,
höfundarréttur, dagsetning, út-
gáfunúmer. markmið, nöfn ein-
{========================================================
I Forricaeining.: Na£n forricaeiningar
I
I Verksvið......: Lýsing á verksviöi og virkni forricaeiningar.
I
I (Undir)ícrric Lýsing
I ----------------------------------------------------------
I Undirrorricar.arn SCuCC iýsir.g á undirtorrici
I
i Forricari: Nafr. forricara (skammscöfun)
■ Breycingarsaga:
I Daasecning Forricari Lýsing á breycingu
:=====================================================}
Mynd 6.
1 2 - Tölvumál