nästa upp förra
Nästa: Kodstyckeskommentar Upp: cdok Konventioner för kommentarer Förra: Procedurkommentar

Deklarationskommentar

Deklarationskommentarer ger en kort beskrivning av varje infört namn (parametrar och lokala variabler). Parameterkommentarerna är nödvändiga för att snabbt förstå vad som görs. Variabelkommentarerna är nödvändiga för att snabbt förstå hur det görs.

void
read_file (
    char             *filename,  /* Path to file to be read     */
    struct complex   *storage[], /* Storage for read numbers    */
    int               size)      /* Size of storage array       */
{
    int               i;         /* Current index in storage[]  */
    struct complex   *tmp;       /* Used for swapping           */

Tips: Om vissa parametrar har relevanta värden på vägen in i proceduren, och andra parametrar har relevanta värden på vägen ut ur proceduren, kan du kommentera dem som i proceduren getline ovan. Parametrar som har relevanta värden både in och ut, får ta två rader i anspråk:

void
getline (
    char    buf[],  /* IN: where to store line        */
    int    *n)      /* IN: max #chars to read         */
                    /* OUT: #chars read, 0 means EOF  */

(I detta fall är det nog bättre att göra som i första versionen av getline, dvs ha två parametrar, en för varje användningsområde. Dessutom kan man då ha tydligare namn.)



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