Schreiben wir Javadoc

Im Gegenteil, wenn Sie Javadoc richtig schreiben Ich kann nicht herausfinden, was die Klasse oder Methode tut, und ich muss gehen, um den Code einzeln zu entschlüsseln. Es ist einfach ineffizient.

In der gegenwärtigen Situation, in der es selbstverständlich ist, dass sich mehrere Personen entwickeln, jemand anderes als Sie Es ist natürlich zu verwenden, was Sie machen Mit anderen Worten, schreiben wir mit mitfühlendem Herzen.

Wo man schreibt

Es ist für Klassen- und öffentliche Methoden erforderlich Was ist privat oder geschützt, vielleicht muss ich es nicht an einem entfernten Ort verwenden? Ist es wie Wenn es am Ende leicht zu verstehen ist, ist es okay

Mit anderen Worten, was zu schreiben

Wenn Sie zu viel schreiben, ist es schwer zu sehen. Ich weiß nicht, was ich tun soll, wenn es nur wenige gibt

Worauf soll ich mich beziehen?

Es ist offiziell, oder?

Jeder liebt System.out.println, der mit der Systemklasse vertraut ist

System.java

/**
 * The <code>System</code> class contains several useful class fields
 * and methods. It cannot be instantiated.
 *
 * <p>Among the facilities provided by the <code>System</code> class
 * are standard input, standard output, and error output streams;
 * access to externally defined properties and environment
 * variables; a means of loading files and libraries; and a utility
 * method for quickly copying a portion of an array.
 *
 * @author  unascribed
 * @since   JDK1.0
 */
public final class System {

So sieht es tatsächlich aus

java.lang.System

Die Systemklasse verfügt über nützliche Klassenfelder und -methoden. Es kann nicht instanziiert werden.

Die von der Systemklasse bereitgestellte Funktionalität umfasst Standardeingaben, Standardausgaben und Fehlerausgabestreams sowie extern definierte Eigenschaften.
Und Zugriff auf Umgebungsvariablen, Laden von Dateien und Bibliotheken, Dienstprogrammmethoden zum schnellen Kopieren von Teilen eines Arrays
Ich werde.
Eingeführte Version:
      JDK1.0

Weil es eine Klassenerklärung ist

• Was macht die Klasse?
• Es wurde klargestellt, dass eine Instanz nicht möglich ist
• Welche Art von Methode gibt es insgesamt?
• Eingeführte Version

Ich denke, was Sie beachten möchten, ist das \

-Tag für die Absatzteilung und das \ -Tag beim Schreiben von Code. Wenn Sie fest in HTML schreiben, ist dies sehr leicht zu erkennen. Das Code-Tag kann {@code null} oder {@linkplain method name display text} sein. Möglicherweise können Sie zum Referenzziel fliegen <ul> <li> </ul> Wenn Sie während der Wiedergabe bearbeiten, wenn auf javadoc fest verwiesen wird, z. B. Aufzählungszeichen und Zeilenumbrüche in \
Das direkt geschriebene Javadoc wird etwas länger sein, aber die Erklärung in der Referenz wird viel einfacher zu sehen sein!

    /**
     * Reassigns the "standard" output stream.
     *
     * <p>First, if there is a security manager, its <code>checkPermission</code>
     * method is called with a <code>RuntimePermission("setIO")</code> permission
     *  to see if it's ok to reassign the "standard" output stream.
     *
     * @param out the new standard output stream
     *
     * @throws SecurityException
     *        if a security manager exists and its
     *        <code>checkPermission</code> method doesn't allow
     *        reassigning of the standard output stream.
     *
     * @see SecurityManager#checkPermission
     * @see java.lang.RuntimePermission
     *
     * @since   JDK1.1
     */
    public static void setOut(PrintStream out) {
        checkIO();
        setOut0(out);
    }

void java.lang.System.setOut(PrintStream out)

setOut
 public static void setOut(PrintStream out)

Weisen Sie den "Standard" -Ausgabestream neu zu.
RuntimePermission, um zu überprüfen, ob der Standardausgabestream neu zugewiesen werden kann, wenn ein Sicherheitsmanager vorhanden ist("setIO")Die checkPermission-Methode wird mit Berechtigungen aufgerufen.
Parameter:
      out -Neuer Standardausgabestream
Ausnahme:
      SecurityException -Ein Sicherheitsmanager ist vorhanden und seine checkPermission-Methode ermöglicht keine Neuzuweisung von Standardausgabestreams.
Eingeführte Version:
      JDK1.1
Verwandte Artikel:
      SecurityManager.checkPermission(java.security.Permission), RuntimePermission