Az algoritmus vagy feladat specifikációja
Egy program vagy algoritmus specifikációja az alábbiakat tartalmazza:
Milyen bemenő adatokat vár a program,
Milyen feltételek érvényesek a bemenő adatokra
Milyen kimenő adatokat várunk, és azokra milyen feltételeket várunk, azaz mikor tekintjük helyesnek és mikor hibásnak az eredményt.
Eljárások, függvények dokumentálása
Minden esetben szükséges a programban meghívott, nem triviális eljárások esetén leírni, hogy mit várunk a meghívott eljárástól. Az eljárás kifejtésekor pedig célszerű leírni az eljárás fejléceként, hogy az eljárás mit végez el, milyen típusú bemenő adatokat produkál és milyen kimenő adatokat várunk tőle.
Algoritmusok dokumentálása általában
A folyamatábrák és struktogramok használata során az algoritmusokat célszerű bő magyarázattal ellátni tekintve, hogy az előbbi két leírás meglehetősen absztrakt. Az algoritmusleíró nyelv használata során a dokumentálás hozzávetőlegesen ugyanolyan mértékű kell, hogy legyen, mint a programok írásánál. Az nem teljesen magától értetődő zárt programrészek előtt tömören le kell írni a feladataikat, esetleg annak magyarázatát, hogy miért pont úgy, azokkal az eszközökkel valósítjuk meg a folyamatot.
beszédközeli pszeudokód (álkód)...
Be: a, b, c
Ha (a > b)
Ha (a > c)
max := a
Másként
max := c
Másként
Ha (b > c)
max := b
Másként
max := c
Ki: max
Nincsenek megjegyzések:
Megjegyzés küldése