2011-01-16 8 views
5

Szukam narzędzia do generowania dokumentacji kodu źródłowego Delphi, i chcę spróbować Doc-O-Matic Express (która jest darmowa). Czy są jakieś wskazówki dla początkujących, jak używać Doc-O-Matic Express do dokumentowania kodu źródłowego Delphi (zarządzanie projektami doc-o-matic, preferowany styl kreślarski, pełna składnia docblock, itp.)?Używanie Doc-O-Matic (Express) z Delphi

+0

Bezpłatnie dla użytku niekomercyjnego. –

+2

Doc-O-Matic jako narzędzie jest naprawdę bardzo dobre, ale ostatecznie jakość dokumentacji jest tak dobra, jak wysiłek włożony w komentowanie kodu. –

+0

Możesz spróbować DelphiCodeToDoc (oprogramowanie opensource napisane z Delphi). Tworzenie pierwszego projektu to kwestia sekund. Po, jeśli potrzebujesz więcej "profesjonalnych" funkcji, wypróbuj Doc-o-matic (który jest BARDZO potężny). http://dephicodetodoc.sourceforge.net/ – TridenT

Odpowiedz

2

Nie przejmuj się teraz ustawieniami Doc-o-matic. Edycja ekspresowa jest tylko w linii poleceń.

  1. Wybierz komentarz styl
  2. Komentarz kod
  3. Generowanie dokumentacji (domyślny projekt jest na tyle, aby rozpocząć)
  4. Sprawdź komentować pokrycia

Doc-O-Matic obsługuje JavaDoc i XMLDoc (lub nawet rodzaj natywnych komentarzy). Samo narzędzie pomoże tylko wtedy, gdy twój kod jest już komentarzem lub jeśli chcesz komentować bezpośrednio w jego IDE.

Jeśli lubisz Doc XML lub javadoc, Doc-O-Matic jest obsługiwany jednakowo dobrze i wszystkie trzy style są obsługiwany pisząc źródło komentuje poprzez zintegrowany edytor powrotem do źródła.

+0

Należy zauważyć, że wersja ekspresowa przyjmuje tylko komentarze z sekcji interfejsu. – pritaeas

+0

@pritaes: Right! a tutaj jest link do macierzy funkcji (Express jest naprawdę wersją bare). http://www.doc-o-matic.com/features.html?tab=matrix – TridenT