Dokumentacja kodu w C

0

hejka, mam pytanie co do dokumentacji kodu w jezyku C. Czy istnieje jakiś jeden standard jak ją pisać? Widziałem już bardzo wiele wariantów i nie wiem który wybrać do mojego projektu.

  1. Funkcja nic nie zwraca. Pisać retval none czy może pominąć?
 * @retval None
  1. Funkcja bez parametrów. Pisać param none czy może pominąć?
 * @param None
  1. Opis funkcji. Dawać na końcu zdania kropkę czy nie?
 * @brief Function adds two numbers.

Dziękuję.

0

Wygeneruj dokumentację i zobacz jak wygląda.

1 użytkowników online, w tym zalogowanych: 0, gości: 1