2012-08-06 15 views
7

Da die Apache-Sprache von Salesforce.com "Java-like" ist, möchte ich javadoc oder Doxygen verwenden, um API-Dokumentation für das Paket zu generieren, das wir in App Exchange veröffentlichen möchten.Dokumentieren von Salesforce.com Apex-Klassendateien

Ich habe ein Projekt ApexDoc auf Google Code gefunden, aber es ist streng begrenzt und verwendet einen naiven Parser, um HTML-Ausgabe zu generieren. Ich würde lieber die vorhandenen Doxygen-Parser und Output-Generatoren nutzen, um das Rad von Grund auf neu zu erfinden.

Also, meine Fragen:

1) Hat jemand in der Lage gewesen javadoc oder Doxygen verwendet API-Dokumentation für ihre Apex-Klassen zu generieren? Wie konntest du es tun?

2) Ich frage mich, wie schwer es wäre, ein einfaches Skript zu schreiben, um eine Reihe von .java-Dateien aus den .cls Apex-Klassendateien zu erstellen, gefälschte import Anweisungen hinzuzufügen und möglicherweise bestimmte Deklarationen zu modifizieren, um Doxygen glücklich zu machen. Irgendwelche Gedanken darüber, was Doxygen (oder Javadoc) erstickt, wenn es versucht, eine Apex .cls-Datei zu parsen?

Ich bin erstaunt, dass Salesforce ein solches Tool nicht bietet oder keinen Apex-Parser zu Javadoc/Doxygen beigetragen hat. Ihre Dokumentations- und Entwicklertools sind umfangreich und sie verfügen über eine großartige automatische Testeinrichtung. Ich habe nichts von ihnen gefunden, um Klassen automatisch zu generieren.

EDIT: Bitte beachten Sie die updated version of this question auf der Salesforce Stack Exchange.

Antwort

1

Ich habe ein Tool basierend auf ApexDoc geschrieben. Es gibt eine kurze Beschreibung here, mit Links zu der JAR-Datei und dem GitHub-Projekt. Bitte hinterlassen Sie einen Kommentar auf meinem Blog, wenn Sie Probleme finden.

+2

Beachten Sie, dass [Link-Only-Antworten] (http://meta.stackoverflow.com/tags/link-only-answers/info) nicht empfohlen werden. SO-Antworten sollten der Endpunkt einer Suche nach einer Lösung sein (vs. noch ein Zwischenstopp von Referenzen, die im Laufe der Zeit abgestanden werden). Bitte beachten Sie, dass Sie hier eine eigenständige Zusammenfassung hinzufügen und den Link als Referenz beibehalten. – kleopatra