nästa upp förra
Nästa: Form Upp: cdok Konventioner för kommentarer Förra: Innehåll

Modulkommentar

Programtexten i en fil/modul inleds med en modulkommentar som presenterar koden i modulen. Alla program, utom de allra minsta, måste delas upp i flera moduler för att möjliggöra effektivt underhåll av koden. I den fil som innehåller funktionen main behövs inte någon modulkommentar.

Information om vem som ansvarar för filen, vilken version det är o.s.v. hanteras bäst m.h.a. en versionshanterare (t.ex. rcs, cvs eller sccs). Tyvärr är det inte alltid möjligt att på ett smidigt sätt få in versionen (från versionshanteringsverktyget) i modulkommentaren. Dessutom skiljer man ofta på leveransversion av modulen, och den version som just headerfilen råkar ha. En modul kan ju bestå av flera filer.

Modulkommentaren ska bara finnas i .h-filen. Om det av någon anledning inte finns en .h-fil, lägger man modulkommentaren i .c-filen. Lägger du modulkommentaren i header filen ska den stå efter #include-skyddet ("#include-wrappern"), med en tom rad emellan. #include-skyddet behöver ofta stå först av allt i .h-filen, så det är lika bra att ha det som standard.

Om du använder PREF-systemet kan du använda genman för att generera manblad utifrån modulkommentaren.





Jonas Mölsä
Sat Sep 13 13:46:34 MET DST 1997