Dokumentacja kodu w C++

Opublikowane: 01/12/2014

w kategorii Zasoby.

Dokumentacja przygotowana wewnątrz kodu może być użyteczna do dokumentowania do dokumentacji API lub modułu kiedy potrzebujesz opublikować opisy swoich klas i funkcji w formie innej niż komentarze w kodzie. Zwykle taka dokumentacja tworzona jest w formie specjalnych komentarzy i następnie eksportowana automatycznie przy użyciu wyspecjalizowanych narzędzi do formy ładnego HTML-a.

Doxygen

Doxygen jest aktualnie moim ulubionym narzędziem do dokumentacji kodu. Eksportuje dokumentację w formie statycznych plików HTML z dołączoną funkcją szukania. Jest dostępny za darmo i nie zmusza Cię do pisania zbyt wiele poza standardowymi komentarzami.

Przykładowa funkcja przygotowana do przetworzenia przez doxygen:

/// Wykonaj sortowanie używając "sort tool" - obiekt z wewnętrzną referencją do kontenera
/// @param[in] aSize Liczba elementów do posortowania
/// @param[in] sortTool obiekt z interfejsem: { value_type, int compare(pos, value); T get(pos); swap(pos1, pos2) }
template<class SortTool>
void sort(size_t aSize, SortTool sortTool)
{
  Details::dtpQuickSorter<SortTool> sorter(aSize, sortTool);
  if (aSize > 1)
    sorter.execute(0, aSize - 1);
}

Zasoby

Udostępnij

obserwuj