javadoc-auto generation für intellij

Gibt es eine automatische Javadoc-generation-plugin für IntelliJ? Beispiel http://jautodoc.sourceforge.net/

InformationsquelleAutor joshjdevl | 2011-01-13
  1. 7

    Javadoc generation (schreiben der .html-Dateien) für Sie erledigt ist on-demand (Extras->Generate Javadoc) und ist im wesentlichen eine automatische sobald Sie es eingerichtet haben. Generierung von javadoc - stubs, was jautodoc für Eclipse tut, das ist getan-Methode-durch-Methode, Klasse von Klasse und nur dort, wo Sie es sagen,.

    Eingabe /** <enter> über eine Methode Signatur erstellen von Javadoc-stubs für Sie. Ich vermute, Sie wollen etwas, das Ihnen diese für eine ganze Datei, ein Paket oder Projekt, obwohl (wie jautodoc). Früher gab es ein solches plugin: http://plugins.intellij.net/plugin/?id=952, aber es funktioniert nicht mit 10.

    Ich muss sagen, dass diese jautodoc Beispiel, während ein ordentliches party-trick, ist das einzelne die meisten nutzlos, was ich je gesehen habe, eine IDE: Es wird eine Beschreibung auf der Basis der Variablen-Namen - aber nur, wenn die variable name ist so beschreibend, dass es nicht noch einen Kommentar in den ersten Platz.

    /**
 * The number of questions
 */
private int numberOfQuestions;

    Macht Sie sehnen sich danach, für gelochte Karte.

    • Manche build-Systeme verwenden, checkstyle, jalopy etc.. Sie am Ende dass die Menschen hinzufügen, die Lahmen javadocs. Best practice ist, um Ihren code für sich selbst sprechen, aber wenn Sie verklebt sind, erstellen Daten aufblasen, weil Sie Ihre Unternehmenspolitik, die es erfordert, dann jautodoc wie die Funktionen sind nice to have. ctrl-alt-j und Sie sind gut zu Begehen.
    InformationsquelleAutor Tim
Schreibe einen Kommentar