Écrivons Javadoc

Au contraire, si vous écrivez correctement javadoc Je ne peux pas comprendre ce que fait la classe ou la méthode et je dois déchiffrer le code un par un. C'est tout simplement inefficace.

Dans la situation actuelle où il est naturel que plusieurs personnes se développent, quelqu'un d'autre que vous Il est naturel d'utiliser ce que vous faites En d'autres termes, écrivons avec un cœur compatissant.

Où écrire

Il est requis pour les méthodes de classe et publiques Qu'est-ce qui est privé ou protégé, je n'ai peut-être pas besoin de l'utiliser dans un endroit éloigné? Est-ce que c'est comme Si c'est facile à comprendre à la fin, ça va

En d'autres termes, quoi écrire

Si vous écrivez trop, ce sera difficile à voir. Je ne sais pas quoi faire s'il y en a peu

À quoi dois-je me référer

C'est officiel, non?

Tout le monde aime System.out.println, familier avec la classe System

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 {

Voici à quoi ça ressemble réellement

java.lang.System

La classe System a des champs de classe et des méthodes utiles. Il ne peut pas être instancié.

La fonctionnalité fournie par la classe System inclut les entrées standard, les sorties standard, les flux de sortie d'erreur et les propriétés définies en externe.
Et l'accès aux variables d'environnement, comment charger des fichiers et des bibliothèques, des méthodes utilitaires pour copier rapidement des parties d'un tableau
Je vais.
Version introduite:
      JDK1.0

Parce que c'est une explication de classe

• Que fait la classe?
• Clarification du fait que l'instance n'est pas possible
• Quel type de méthode existe-t-il dans son ensemble?
• Version introduite

Je pense que vous voulez faire attention à la balise \

pour la division de paragraphe et la balise \ lors de l'écriture du code. Ecrire fermement en HTML le rend très facile à voir. La balise de code peut être {@code null} ou {@linkplain method name display text} Vous pourrez peut-être voler vers la destination de référence <ul> <li> </ul> Si vous modifiez en regardant lorsque javadoc est fermement mentionné, comme des puces et des sauts de ligne dans \
Le javadoc directement écrit sera un peu plus long, mais l'explication dans la référence sera beaucoup plus facile à voir!

    /**
     * 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)

Réaffectez le flux de sortie "standard".
RuntimePermission pour voir si le flux de sortie standard peut être réaffecté, si un gestionnaire de sécurité existe("setIO")La méthode checkPermission est appelée avec des autorisations.
Paramètres:
      out -Nouveau flux de sortie standard
exception:
      SecurityException -Un gestionnaire de sécurité existe et sa méthode checkPermission ne permet pas la réaffectation des flux de sortie standard.
Version introduite:
      JDK1.1
Article connexe:
      SecurityManager.checkPermission(java.security.Permission), RuntimePermission