Dokumentacija v prologu
Iz E-študij, proste zakladnice študentskega znanja
- Članek govori o dokumentaciji v programskem jeziku Prolog.
V komentarjih naj bodo opisane:
- naloge procedur
- vhodni in izhodni argumenti
- omejitve uporabe procedure
- obrazloženi nerazumljivi deli kode (npr. uporabljene zvijače pri programiranju)
Če je koda sama po sebi dovolj razumljiva, je komentar odveč!
K osnovni dokumentaciji spada še:
- naslov avtorja
- opis naloge
- opis vhodno izhodnih operacij
- opis uporabljenih algoritmov
- opis glavne strukture
- opis uporabljenih podatkovnih struktur
- priročnik
