Generator dokumentacji PHPDoc na platformie Eclipse lub poza nią?

Question

Pracuję z Eclipse + PDT. Dodałem komentarze phpdoc do mojego kodu, , ale w rzeczywistości nigdy nie wygenerowałem wynikowej dokumentacji w Eclipse. Jak mam to zrobić - czy w Eclipse jest jakaś funkcjonalność, czy generowanie dokumentów powinno być wykonywane zewnętrznie?

Answer 1

Aby wygenerować dokumentację, należy użyć wersji phpDocumentor, którą można zainstalować jako pakiet PEAR.

Następnie należy wywołać go z wiersza polecenia; Nigdy nie widziałem, żeby to było wywoływane z Eclipse PDT.

Doskonałym rozwiązaniem jest posiadanie platformy do ciągłej integracji (na przykład przy użyciu phpUnderControl) i zintegrowanie z utworzeniem pliku phpdoc w pliku konfiguracyjnym kompilacji; w ten sposób phpdoc jest generowany za każdym razem, gdy ktoś popełnia (lub raz dziennie, lub gdy tylko chcesz ^^).

W Eclipse PDT można wywołać "narzędzia zewnętrzne" (patrz "Uruchom> Narzędzia zewnętrzne" w menu); to pozwoliłoby ci uruchomić komendę phpdoc (tak jak robisz z CLI); ale to zdecydowanie nie jest tak przyjazny dla użytkownika jak co Zend Studio oferuje - nie w tej samej cenie albo, chociaż ^^

Answer 2

Tak, istnieje kreator do wykonania tej czynności w Zend. Sprawdź to brief guide.

Alternatywnie można utworzyć zewnętrzną konfigurację uruchamiania w celu wywołania standardu phpDocumentor.

1. Wybierz Run-> Zewnętrzna Narzędzia-> Narzędzia zewnętrzne Konfiguracje ...
2. W okienku po lewej stronie wybierz program to nowa ikona (po lewej najbardziej ikona nad okienkiem).
3. W prawym panelu wybierz kartę Główna.
4. Wpisz generate_doc w polu Name :.
5. Wprowadź ścieżkę do narzędzia phpdoc cli w polu Lokalizacja:.
6. Wprowadź wymagane argumenty w polu Argumenty, np. dla bieżącego wkładu projektu $ {project_loc}.
7. Aby uruchomić konfigurację zewnętrzną, wybierz Uruchom.

Aby ponownie uruchomić konfigurację masz kilka możliwości:

1. wybierz zewnętrzny narzędzi ikonę z paska menu external tools icon http://help.eclipse.org/ganymede/topic/org.eclipse.cdt.doc.user/images/icon%5Fext%5Ftools.png" następnie kliknij generate_doc
2. Wybierz Run-> Zewnętrzna Narzędzia-> generate_doc
3. Hit Alt + R, E, 1 (zakładając, że generate_doc jest pierwszą pozycją na liście, w przeciwnym razie wybierz odpowiednią liczbę)

Answer 3

Innym doskonałym narzędziem do generowania dokumentacji jest ApiGen. Nie wymaga instalacji z PEAR (ale zawiera go) i może być używany jako samodzielny pakiet.