Javadoc-Vorlagengenerator [geschlossen]

StackOverflow https://stackoverflow.com/questions/29689

  •  09-06-2019
  •  | 
  •  

Frage

Ich habe eine große Codebasis ohne Javadoc und möchte ein Programm ausführen, um ein Gerüst mit den grundlegenden Javadoc-Informationen zu schreiben (z. B. für den Parameter jeder Methode @param schreiben ...), also muss ich nur die verbleibenden Lücken füllen.

Kennt jemand hierfür eine gute Lösung?

Bearbeiten:

JAutodoc ist das, wonach ich gesucht habe.Es verfügt über Ant-Aufgaben, ein Eclipse-Plugin und verwendet Velocity für die Vorlagendefinition.

War es hilfreich?

Lösung

Der JAutodoc Das Plugin für Eclipse macht genau das, was Sie brauchen, aber mit einer Paketgranularität:

Klicken Sie mit der rechten Maustaste auf ein Paket, wählen Sie „Javadoc für Mitglieder hinzufügen …“ und das Grundgerüst wird hinzugefügt.

Es gibt zahlreiche interessante Möglichkeiten:Vorlagen für Javadoc, indem im Header jeder Datei ein TODO hinzugefügt wird, das besagt:„Vorlage Javadoc, muss ausgefüllt werden …“ usw.

Andere Tipps

Ich denke, die automatische Generierung leerer Javadocs ist ein Anti-Pattern und sollte nicht empfohlen werden.Es verleiht dem Code den Anschein, als wäre er dokumentiert, fügt der Codebasis jedoch lediglich Rauschen hinzu.

Ich würde stattdessen empfehlen, dass Sie Ihren Code-Editor so konfigurieren, dass er auf einer Basis pro Methode und pro Klasse hilft, wenn Sie das Javadoc tatsächlich schreiben (ein Kommentator verwies auf die Funktion von Eclipse, die dies tut).

Sie können Ihren Cursor auch auf die Zeile über einer Methode setzen, die Sie in JavaDoc einfügen möchten, und dann Folgendes eingeben:

/**

und drücken Sie die Eingabetaste.Dadurch wird Ihr JavaDoc-Stub generiert.

Sie können Eclipse so konfigurieren, dass Warnungen für Dinge angezeigt werden, denen Javadoc fehlt, oder über Javadoc verfügen, das nicht alle Informationen oder falsche Informationen enthält.Es können auch Vorlagen eingefügt werden, die Sie ausfüllen können.

Nicht ganz das Tool, nach dem Sie gefragt haben, aber wahrscheinlich besser, weil Sie bei Methoden, die Sie verpasst haben, nicht mit leeren Gerüsten enden werden.

Sie können dies erreichen, indem Sie die Einstellungsseite hinter dem Pfad „Fenster“ > „Einstellungen“ > „Java“ > „Compiler“ > „Javadoc“ für Ihren Arbeitsbereich untersuchen und bearbeiten.Der Screenshot dieser Einstellungsseite ist unten:

The so-called Javadoc preference page

Für weitere Informationen zu den Elementen in diesem Bildschirm folgen Sie bitte dem untenstehenden Link:

Hilfe zu Java-Compiler-Javadoc-Einstellungen

Wählen Sie die Methode aus dass Sie Javadoc hinzufügen möchten und alt+Schicht+J, erstellt automatisch den Javadoc-Kommentar.

BEISPIEL:

/**
     * @param currDate
     * @param index
     * @return
     */
    public static String getAtoBinary(String currDate, int index){  
        String HourA = "0";
        try{
            String[] mydate = currDate.split("/");
            HourA = mydate[index].substring(1, 2);
        }catch(Exception e){
            Log.e(TAG, e.getMessage());
        }
        return HourA;
    }

Wenn Sie in Eclipse mit der rechten Maustaste auf die Quelle einer Datei klicken, steht im Quellmenü eine Option zur Javadoc-Generierung zur Verfügung.

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top