Warnung: Baumeln Javadoc-Kommentar

Da ich aktualisierte mein Android Studio (2.3.1) und build-tools (2.3.1), ich erhalte eine Warnung,

Achtung: Baumeln Javadoc-Kommentar

für Kommentare wie,

/** set name with format, {@Link FORMAT_NAME} **/
setNameText(getFormattedName(FORMAT_NAME));

Wie Sie sehen können, ich benutze javadoc-Stil-Kommentar für die Verlinkung und andere. Ich Frage mich, ob es gibt andere Kommentar alternativen, die verknüpfen-Funktion.

Dank.

  • Kommentar erwähnt, sollte wirklich regelmäßige javadoc-Kommentar für die Methode. Dies ist, weil, Kommentar beschreibt, was die Methode tut, und code-Kommentare sollten beschreiben - warum fordern Sie, dass die Methode und nicht die anderen.
InformationsquelleAutor Dhunju_likes_to_Learn | 2017-04-12
  1. 14

    Es sieht aus wie Sie mit einem Javadoc-Kommentar ein, wenn Sie nennen die Methode setNameText. Javadoc-Kommentare eingefügt werden oben eine Klasse Erklärung, ein Methode Erklärung, oder ein Feld Erklärung.

    Möchten Sie einfach einen Kommentar beim aufrufen der Methode, mit der one-line-Kommentar: //get formatted name based on {@link FORMAT_NAME}.

    • aber mit one-line-Kommentar, mit {@link FORMAT_NAME} nicht zu verknüpfen, wie es mit Javadoc-Kommentar. Ich habe diesen auf der Android Studio IDE.
    • Das mag so sein, aber die Tatsache bleibt, dass, wo Sie platziert haben, der Kommentar ist ein falscher Ort für einen javadoc-Kommentar.
    • vereinbart.
    InformationsquelleAutor gjigandi
  2. 4

    Können Sie einfach schalten Sie es aus auf der Seite "Datei-Einstellungen-Editor-Inspektionen-Java-Javadoc-Themen-Baumeln Javadoc-Kommentar".

    • Warnungen sind da, um zu helfen, verbessern die Qualität des Codes, die Sie nicht nur Sie ausschalten. Es gibt einen Grund hinter dieser Warnung, wie die anderen Antworten erklären.
    • Das einzige Szenario, wo Sie vielleicht schalten Sie eine Warnung, wenn Sie überzeugende Gründe dafür, dass die Warnung unnötig ist, die ich glaube nicht, dass es hier der Fall ist. Wenn Sie wirklich denken, dass diese Warnung unnötig ist, sollten Sie Ihre Gründe zu erklären in Ihrer Antwort. Dank
    • bashiri, könnten Sie bitte erklären, was ist der Grund für diese Warnung? Das einzige, was ich sehe, falsch über die Verwendung von javadoc-Kommentar wie dieser ist, dass Sie bricht mit der Konvention.
    InformationsquelleAutor Qian Sijianhao
  3. 3

    Sie sind mit Javadoc-format, die beginnt mit /** statt eines block-format Kommentar beginnt mit /* .

    Zu lindern, die Warnung, beginnen Sie immer Ihre Kommentare in den Methoden, die mit /* nicht /**.

    InformationsquelleAutor dev_mjm
  4. 1

    Ersetzen Sie einfach "Baumeln Javadoc-Kommentar" mit block-Kommentar.

    • Dann können Sie nicht verwenden, {@link } - indiziert durch IDEs nur in den javadocs.
    • Wenn u wollen, verwenden Sie {@link}, vielleicht die beste Wahl ist, deaktivieren Sie die "Dangling Javadoc-Kommentare" - Bericht in die ALS die Kontrollen. Dann kann u verwenden Sie "Javadoc-Kommentare" überall, aber dies wird nicht empfohlen.
    InformationsquelleAutor Cobain
  5. 0

    Mir scheint, der richtige Ort für diesen Kommentar ist neben der Methode getFormattedName (), weil Ihr Kommentar erläutert die Funktionalität der Methode nicht der Grund, Sie nennen es.

    • Ich habe die Frage zu reflektieren, was dieses Stück code tut. Ich nahm ein einfaches Beispiel hier, aber in vielen Fällen, die ich brauchen, um einen langen Kommentar zu beschreiben, was ein Codeblock tut. Und oft muss ich mit den @ - link-link auf andere stellen im code, so dass es einfacher ist, zu Folgen/verstehen den Kommentar.
    • Sie können die Verwendung von @link in die Kommentare. Look at docs.oracle.com/en/java/javase/11/docs/specs/... "Dieser tag [@link] ist gültig in der Dokumentation Kommentar: übersicht, Modul, Paket, Klasse, interface, Konstruktor, Methode und Feld". Dies ist das richtige format {@link Paket.Klasse#member label }
    • das wäre perfekt gewesen! Aber wenn ich getestet mit {@link}, die mit einer Zeile kommentieren, aber es ist kein link 🙁 . Auch, spec sagt, dass jede Art von "Dokumentation" Kommentare.
    InformationsquelleAutor pedram bashiri
Schreibe einen Kommentar