Dokumentowanie kodu

Na samym początku pliku z funkcją główną programu, umieszczamy blok komentarza według następującego wzoru:

/**
 * \file   nazwa_pliku.c
 * \author Imie Nazwisko
 * \date   miesiac, rok
 */

Jeżeli chcemy na podstawie naszego kodu wygenerować automatycznie dokumentację, przed deklaracją każdej funkcji zamieszczamy podobny blokowy komentarz, zawierający krótki opis działania funkcji, poszczególnych parametrów oraz zwracanej wartości

/**
 * Zlicza liczbę próbek w pliku
 * \param nazwa nazwa pliku
 * \param separator znak, którym rozdzielone są kolumny danych w pliku
 * \return liczba próbek lub wartość -1 w przypadku błędu
 */
int policz_probki(char* nazwa, char separator);

Dzięki takiemu przygotowaniu kodu źródłowego, możemy automatycznie wygenerować dokumentację przy pomocy programu Doxygen.

Jeżeli kod wymaga komentarza to znaczy, że nie jest wystarczająco czytelnie napisany. Zamiast komentarzy należy stosować jasne nazwy zmiennych i funkcji, komentować w ostateczności.