15.1.1 Valmiin kommenttilohkon lukeminen
Aliohjelman kirjoittaminen aloitetaan vaikkapa seuraavan f.c - nimisen
tiedoston lukemisella koodin sekaan (seuraavassa kursiivilla kirjoitetut osat
eivät ole mukana tiedostossa):
komloh\f.cpp - pohja funktioiden kirjoittamiselle
//***************************************************************************
int //
funktio( // Funktion eri paluuarvot
//
p1 ,// s Selitys Parametrin merkitys
p2 ,// t Selitys
p3 // s Selitys
)
/*
** Funktiolla ... Lyhyt (mutta riittävä) kuvaus siitä, MITÄ funktio tekee
**
** Globaalit: Globaalit muuttujat joita ohjelma tarvitsee
** Muuttuu: Muuttujat (yleensä glob) joita muutetaan ja eivät ole param.listassa
** Syöttö: Mistä saadaan syöttö
** Tulostus: Mihin tulosteet
** Kutsuu: Mitä aliohjelmia kutsutaan (usein tarpeeton rivi)
** Tekijä: Vesa Lappalainen
** Pvm: 26.01.1997
** Algoritmi: Miten funktio tekee tehtävänsä
** Esimerkki: Muutama selventävä esimerkki
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
{
}
Lohkokommenteissa (kommenttia monta riviä peräkkäin) **
pyritään saamaan alkamaan sarakkeesta 1. Miksikö?
Tällöin ohjelman dokumentointia voidaan automatisoida siten,
että kerätään kustakin tiedostosta ne rivit, joissa on **
1. sarakkeessa.