2013-01-10 18 views
6

Dokumentuję kod używając Doxygen i zastanawiałem się, czy istnieje słowo kluczowe do deklarowania argumentu funkcji jako opcjonalnej. Coś jak:Doxygen - zadeklaruj parametr jako opcjonalny

/*! 
\fn int add(int a, int b=0) 
\brief adds two values 
\param a the first operand 
\param \optional b the second operand. Default is 0 
\return the result 
*/ 

Wygląda na to, że to powinno istnieć, ale nigdzie go nie znalazłem. Czy istnieje rzeczywista opcja, czy też muszę po prostu zanotować w opisie?

Odpowiedz

8

Aby odpowiedzieć na pytanie: Nie, nie ma czegoś takiego.

Ale nie podzielam twojej opinii, że coś takiego powinno istnieć. Wszakże deklaracja funkcji będzie wyświetlana razem z jej dokumentacją, więc każdy może zobaczyć, że b jest opcjonalny i jaki jest jego domyślny argument. I dla \fn zobacz dokumentację doxygen's discouraging the use of \fn.

+0

Warto wiedzieć. co powinienem użyć zamiast "\ fn" dla funkcji globalnych? – ewok

+0

Nic - po prostu umieść komentarz dokumentujący tuż przed funkcją (-deklaracja), tak jak w linku, który napisałem mówi (pierwszy akapit) –

0

Czego chcesz, nie jest dostarczany przez Doxygen - będziesz musiał ręcznie zanotować go w opisie.

Powiązane problemy