6
Ist es notwendig, Javadoc als Teil des Build-Prozesses zu generieren?Ist es notwendig, Javadoc als Teil des Build-Prozesses zu generieren?
A
Antwort
1
Nein ist es nicht notwendig
11
Nun gibt es nichts zwingt Sie wirklich, es zu tun, aber wenn Sie Ihre Build-Artefakte als nutzbare Bibliothek verteilen wollen es hilft sicherlich gut geschrieben haben Javadocs, dass die Menschen vor blättern Sie laden sogar Ihre JAR herunter.
3
Nein. Was Sie in einem Build-Prozess tun, liegt bei Ihnen (oder dem Kunden). Einige Build-Systeme enthalten zwar standardmäßig die JavaDoc-Generierung, sollten aber einfach zu deaktivieren sein.
1
Sie erwähnen nicht, ob es sich um einen Build für eine Webanwendung oder eine Bibliothek für die Verteilung handelt. Wie andere Replikatoren erwähnt haben, ist dies nicht wirklich notwendig, aber sowohl für eine intern unterhaltene Web-App als auch für eine extern verteilte Bibliothek wird Dokumentation (in Form von Javadoc) äußerst nützlich sein.
0
Wenn Ihr Build-Prozess Ant verwendet, würde ich sagen, dass es nicht notwendig sein kann, aber es sollte keine Härte sein. Sie verwenden einfach die Javadoc-Aufgabe, generieren sie und machen damit fertig.
1
Überhaupt nicht.
Wenn die meisten Benutzer Ihres Codes direkt auf die Java-Dateien zugreifen und eine IDE verwenden, lesen sie wahrscheinlich bereits ihre JavaDocs über die Hover im Code-Editor. Das ist möglicherweise aktueller als die Version, die eingecheckt wird oder die erstellt wird (es sei denn, Sie haben fortlaufende Builds).
Wenn Sie Zwischenversionen für Clients bereitstellen (z. B. wenn Sie ein Open Source-Projekt sind), bindet Sie die JavaDocs und nicht nur die Klassendateien weiter an bestimmte Semantiken. Es ist sinnvoll, eine strengere Kontrolle über Ihre API bereitzustellen, und Ihre JavaDocs beschreiben im Wesentlichen Ihre API.
Wenn Sie nicht möchten, dass externe Benutzer Ihre öffentlichen Schnittstellen verwenden (z. B. halten Sie sie für zukünftige Plug-Ins offen), können Sie dies nicht verhindern, aber Sie können sicherlich verhindern, dass JavaDocs bereitgestellt werden.
0
Sie entscheiden, ob es notwendig ist oder nicht. Persönlich erzeuge ich keine Javadoc und andere schwere Berichte (die ein bisschen teuer zu generieren sind) bei jedem Build, ich möchte den Build auf den Entwicklern Maschinen und durch die kontinuierliche Integration Engine so schnell wie möglich laufen lassen (Die Continuous Integration Engine erstellt und veröffentlicht Source-Jars. Die Berichterstellung erfolgt während des nächtlichen Builds.
0
Ist es notwendig, Javadoc als Teil des Build-Prozesses zu generieren?
Kein