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
5
A
Odpowiedz
1
W tym page można znaleźć doc, które mogą być przydatne dla Ciebie Delphi Documentation Guidelines
. Użyłem tych wytycznych do udokumentowania mojego kodu źródłowego w tym project.
2
Nie przejmuj się teraz ustawieniami Doc-o-matic. Edycja ekspresowa jest tylko w linii poleceń.
- Wybierz komentarz styl
- Komentarz kod
- Generowanie dokumentacji (domyślny projekt jest na tyle, aby rozpocząć)
- 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.
Powiązane problemy
- 1. Używanie Skrzypka z IIS7 Express
- 2. Używanie app.configure w Express
- 3. Używanie TChromium, Delphi Chromium Embedded
- 4. Używanie biblioteki DLL Delphi w C#
- 5. Bootstrapping SQL Express z WiX?
- 6. delphi Używanie rekordów jako klucza w TDictionary
- 7. letsencrypt-express z Socket.IO
- 8. Używanie Express i Node, jak utrzymać sesję między subdomenami/hostheaders
- 9. Wywołanie metody Delphi z innego programu Delphi
- 10. Używanie LESS z node.js
- 11. Express dane formularza js
- 12. Problemy z Delphi Chromium Embedded
- 13. Używanie odwołania do określonego typu klasy w konstruktorze atrybutów Delphi
- 14. Używanie Delphi do śledzenia zmian dokonanych w folderze?
- 15. Socket.io emitują z kontrolerów Express
- 16. Uchwyt Express Subdomain z nginxem
- 17. Renderowanie Base64 PNG z Express,
- 18. Współdziałanie Delphi z .NET
- 19. Ustaw nagłówki Express Express przed przekierowaniem
- 20. Tablica renderowania przekazywana z Express z Jade
- 21. Problem z sesją krzyżową z Express 3
- 22. "Delphi Fundamentals" w Delphi 2009
- 23. Przenieś projekt z Delphi 3 do Delphi 2010
- 24. Problemy z ciągami migracyjnymi Delphi 3 do Delphi 2010
- 25. Migracja serwera kompilacji z Delphi XE do Delphi XE2
- 26. Jak przekonwertować TStringGrid z Delphi 7 do Delphi XE
- 27. Używanie Qt z Visual Studio bez dodatku
- 28. Delphi Usuwanie obiektu z TObjectList
- 29. Procedury Delphi z parametrami łańcuchowymi
- 30. Delphi Jak korzystać z TGridPanel
Bezpłatnie dla użytku niekomercyjnego. –
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. –
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