Autor Wątek: Doxygen i metody wirtualne  (Przeczytany 1044 razy)

Offline mararok

  • Użytkownik
    • Dark Program

# Sierpień 21, 2010, 20:15:23
Jakę opcję trzeba włączyć w doxygenie, żeby w dokumentacji generował opis metod wirtualnych(A nie Reinterpretacja w ...) ??
Czy trzeba w ogóle dokumentować klasy interfejsów??

Edit: już się wszystko wyjaśniło.
« Ostatnia zmiana: Sierpień 21, 2010, 21:56:14 wysłana przez mararok »

Offline Mr. Spam

  • Miłośnik przetworów mięsnych

Offline Zielony

  • Użytkownik
    • Ghurund Engine

# Sierpień 21, 2010, 21:52:37
Odpowiem na drugie pytanie, bo nie korzystam konkretnie z doxygena:
Warto dokumentować wszystko, co jest przeznaczone do wykorzystania przez użytkownika (czyli innego programistę). Do tego zwykle zaliczają się wszystkie elementy kodu niebędące prywatnymi.

Offline Reg

  • Administrator
    • Adam Sawicki - Home Page

# Sierpień 22, 2010, 22:32:25
Moim zdaniem warto włączyć w opcjach generowanie dokumentacji dla wszystkich publicznych pól i metod, natomiast dokumentować wszystko nie zawsze jest sens. Czasami rola metody i jej parametrów jest jasna już po samej nazwie i wtedy powtarzanie tego samego w komentarzu z dokumentacją jest moim zdaniem bez sensu.

Szkoda, że nie da się w Doxygen wyłączyć ostrzeżeń, które drukuje za każdym razem, kiedy do jakiejś funkcji czy metody udokumentowane są wybrane, ale nie wszystkie parametry :(