2012-08-06 13 views
7

Ponieważ język Apex w Salesforce.com jest "podobny do Java", chciałbym użyć javadoc lub Doxygen do wygenerowania dokumentacji API dla pakietu, który planujemy udostępnić w App Exchange.Dokumentacja plików klasy Apex w klasie Salesforce.com

Znalazłem projekt ApexDoc na Google Code, ale jest on mocno ograniczony i wykorzystuje naiwny analizator składni do generowania danych wyjściowych HTML. Wolałbym korzystać z istniejących analizatorów Doxygen i generatorów wyjściowych, niż próbować od nowa tego koła od zera.

Więc moje pytania:

1) Czy ktoś był w stanie wykorzystać javadoc lub Doxygen do generowania dokumentacji API dla swoich klas Apex? Jak mogłeś to zrobić?

2) Zastanawiam się, jak trudno byłoby napisać prosty skrypt, aby utworzyć serię plików .java z plików klas Apex .cls, dodając fałszywe oświadczenia import i ewentualnie modyfikując niektóre deklaracje, aby zadowolić Doxygen. Jakieś myśli o tym, co Doxygen (lub javadoc) dławi, kiedy próbuje sparsować plik Apex .cls?

Jestem zaskoczony, że Salesforce nie zapewnia takiego narzędzia lub nie wniosło parsera Apex do javadoc/Doxygen. Ich dokumentacja i narzędzia programistyczne są obszerne i mają świetną, zautomatyzowaną konfigurację testów. Nie znalazłem od nich niczego dla klas generujących automatycznie.

EDYCJA: Proszę zobaczyć updated version of this question na Salesforce Stack Exchange.

Odpowiedz

1

Napisałem narzędzie oparte na ApexDoc. Istnieje krótki zapis here z linkami do pliku JAR i projektu GitHub. Zostaw komentarz na moim blogu, jeśli znajdziesz jakieś problemy.

+2

Należy pamiętać, że [odpowiedzi dotyczące tylko łącza] (http://meta.stackoverflow.com/tags/link-only-answers/info) są odradzane, odpowiedzi SO powinny być punktem końcowym wyszukiwania rozwiązania (vs. kolejny przystanek odniesień, które z czasem stają się nieaktualne). Proszę rozważyć dodanie samodzielnego streszczenia tutaj, zachowując odnośnik jako odniesienie. – kleopatra