Muss ich javadoc jede einzelne Methode oder nur um die 'main' - Methode in java?

Java-Beispiel-Methode:

//Stores the user input into an integer variable called 'choice'
int choice = keyboard.nextInt();

Muss ich schreiben javadoc für eine einfache Methode, wie dies oder sollte ich nur Dokument die main-Methode eines Programms, wenn ja, dann welche Art von Dinge, die sollte Schreibe ich für die main-Methode?

Dank,

Chris.

  • Es ist nicht eine Methode.
InformationsquelleAutor Chris | 2009-12-02
  1. 10

    Damit erklärt in deinem anderen thread:
    Was soll ich schreiben in meinem javadoc der Klasse und Methode, die Kommentare?

    Was du gepostet hast, ist nicht eine Methode. Sie brauchen nicht zu kommentieren jede Zeile code, die, selbst für eine Zuordnung. Wenn Sie so etwas offensichtliches wie:

    i++;

    Brauchen Sie nicht, es zu kommentieren mit "Schritten, die ich von einem."

    Wieder, code-Kommentare (einschließlich JavaDoc) keinen Einfluss auf die Ausführung des Codes.

    InformationsquelleAutor Gazler
  2. 4

    Müssen? Das hängt davon ab, was du damit meinst "müssen".

    Ich denke, es gibt ein paar Verwirrungen, die in Ihrer Frage. Einer von Ihnen ist, was eine Methode. Sie scheinen zu Fragen über die Kommentare im Allgemeinen. Javadocs sind eine spezielle form von Kommentar (mit einer bestimmten syntax). Auch eine Haarspalterei: dein Beispiel oben ist nicht eine Methode. Es ist eine einzige Zeile code.

    Sondern darum, dass nur, ich würde nicht verwenden, die Kommentar. Klar Sie uns eine variable mit dem Namen "Auswahl". Das einzige, was interessant ist, was nextInt tut, aber wer neugierig ist sollte in der Lage sein, den Mauszeiger über die nextInt() Methode, und sehen Sie die javadocs.

    InformationsquelleAutor CPerkins
  3. 2

    Zunächst, dass Beispiel ist nicht javadoc, nur ein code Kommentar

    Hier ist eine Anleitung, javadoc
    Wie Schreibe javadoc

    Und Sie sollten nur javadoc-public-facing Methoden

    InformationsquelleAutor Ovi Tisler
Schreibe einen Kommentar