Poniżej w przykładowym programie zaprezentowane zostały podstawowe wymagania odnośnie kodu programu i komentarzy. Komentarze mają być dla narzędzia Doxygen. Mogą Państwo pisać komentarze w jednym z dwóch stylów:

• w stylu jak dla C++ - przykładowe komentarze zpstaną udostępnione wkrótce,
• w stylu a la JavaDoc - przykład poniżej:

/**
* @file silnia.c
* @author Krzysztof Kluza
* @date 06.11.2009
* @version 1.0
* @brief Program liczacy silnie
*
* @section Description
* Program liczacy rekurencyjnie silnie liczby 6 i wyswietlajacy wartosc na ekranie.
*/
 
#include <stdio.h>
 
int silnia(int liczba);
 
int main(void) {
	int x = 6; /* zmienna przechowująca liczbę, której silnię wyliczamy */
	printf(" 6! wynosi %d\n",silnia(x));
	return 0;
}
 
/**
* @em Silnia
* Funkcja obliczajaca silnie zadanej liczby
*
* @param  liczba liczba której silnię liczymy
* @return silnia z liczby
*/
int silnia(int liczba) {
	int zwrot = 1;
	if(liczba>=2) zwrot = liczba * silnia(liczba-1);
	return zwrot;
}
 

Uwagi:

• zmienna x została opisana komentarzem tylko dlatego, że jej nazwa jest mało znacząca Standardowo komentarza NIE powinno tam być, a zamiast tego powinniśmy stosować nazwy znaczące, tak by kod był czytelny (samodokumentujący)! Jeśli w zmiennej przechowujemy wartosc np. przyblizenia liczby A to należy odpowiednio nazwać zmianną np.: przyblizenieA, przyblizenie_A, przyblA, przybl_A, i_przyblA itp. Ostatni przykład to użycie notacji węgierskiej.
• nazwy funkcji również powinny być samodokumentujące, a w samej funkcji main() powinien być czytelny algorytm wykonywania się samego programu, zaś fragmenty wykonujące jakieś większe części programu (szczególnie występujące w różnych miejscach programu) powinny występować w osobnych funkcjach.

Linki:

• Przykład prostego programu z wygenerowaną dokumentacją
• Documenting the code with Doxygen