Grails: Alternatives to Grails Doc?

Question

Dokumentacja utworzona przez uruchomienie grails doc nie jest w pełni satysfakcjonująca w moich oczach. Na przykład działania w kontrolerach pojawiają się jako właściwości w dokumentacji, chociaż chciałbym mieć dodatkową sekcję do oddzielania akcji od rzeczywistych właściwości (łańcuchów itp.).

Czy istnieją jakieś narzędzia, które działają na komentarze podobne do JavaDoc i generują lepszy wynik dla projektów Grails? Powinien on być Grails-aware (czyli rozumie, że zamykanie w sterownikach są rzeczywiście działania) lub umożliwiają wyraźne oznaczanie (np @section Actions komentarz sprawia, że ​​ustęp pojawiają się w sekcji „Akcje”)

Answer 1

Spójrz na projekcie grails-new-doc .

Answer 2

Sprawdź wtyczkę "Grails Runtime Docs" (http://grails.org/plugin/grails-runtime-docs). Wygeneruje ona świetną dokumentację z środowiska wykonawczego, w tym metody dynamiczne, dodając "Podsumowanie metody dynamicznej" & "Szczegóły metody dynamicznej" w wygenerowanych dokumentach html, które zawierają ich informacje źródłowe. To więcej informacji o Grails i klasyfikuje klasy w kontrolerach, komendach, domenach, usługach i bibliotekach znaczników. Uwaga: Jestem programistą grails i wnieśliśmy tę wtyczkę open source do Grails. Mam nadzieję, że okaże się to przydatne.

Answer 3

Wygląda na to, że używasz starszej wersji Grails.

Najnowsza wersja Grails zawiera wiele ulepszeń w dokumencie grails. Ponadto firma Grails zaleca obecnie, aby czynności kontrolerów były kodowane jako metody, a nie zamknięcia, które mogą rozwiązać problem.

Jeśli martwisz się o aktualizację, używam Grails od 2008 roku i zawsze aktualizuję się, gdy pojawią się nowe wersje.

Aktualizacja oprogramowania Grails nie trwała dłużej niż jeden dzień, zaktualizuj kod w celu udokumentowania "udokumentowanych zmian", uruchom testy i wróć, jeśli znajdę jakieś problemy.

Ponieważ aktualizacja jest tak łatwa, zawsze staram się nadążać za najnowszą stabilną wersją.

Przy okazji, wtyczki mogą być problematyczne. Powinieneś, lub oczywiście, mieć testy dla dowolnych wtyczek, których używasz. W rzeczywistości lepsze wtyczki zawierają już testy, które można uruchomić.