[Mots qui m'ont été épelés lorsque j'étais en première année ⑪] Veuillez comprendre la méthode de codage Java minimale. (2ème: édition Javadoc)

――Maintenant, le onzième article que vous pouvez simplement écrire comme une lettre que vous l'utilisez naturellement. «Je dois laisser les mises à jour quotidiennes pendant environ deux jours, et jouer un saut dans le temps avec le sentiment que je peux le remplacer par n'importe quoi. «Même si seulement deux jours se sont écoulés, on a l'impression que ça fait un moment, et vous pouvez voir comment vous avez continué à vous échapper de la réalité chaque jour et à affronter sérieusement des illusions. Cette fois, envoyons la deuxième copie de la méthode de codage Java, en continuant à partir de la dernière fois.

Pratique de codage Java

<À ce moment-là>

―― "Convention" ... Je faisais attention uniquement à la dénomination de base des classes, méthodes, variables, etc. ―― «Méthode» ・ ・ ・ Dès la phase d'apprentissage, je ne l'ai pas décrite consciemment, et j'ai pensé que ce serait bien si je pouvais comprendre le sens.

→ Dans le développement de l'équipe, etc., la description manque d'uniformité et de lisibilité, ce qui cause beaucoup d'inconvénients.

――Re-apprendre des bases sur les règles et les manières dans les livres et en ligne.

Javadoc

Aperçu

--Javadoc est un mécanisme pour générer des spécifications d'API au format HTML à partir du code source.

règle

Exemple

/**
 *Classe d'essai
 *
 * @author t_o_d
 * @version 4.6
 * @see <a href="https://www.google.co.jp/">Google</a>
 */
public class Test{
  /**
   *message
   */
  private String message;

  /**
   *âge
   */
  private int age;

  /**
   *Paramètres d'information
   
   * @param name
Nom
   * @param number
numéro personnel
    @Remplacement obsolète par une autre méthode{@link #infoConfiguration(String name, int number)}
   */
  public void setInfo(String name, int number){

  }

  /**
   *Obtenir un message
   * @message de retour
   * 
   * <pre>
   *Le réglage est{@link com.example.Main#setResult()}
   *Le réglage est{@linkplain com.example.Main#setResult()}
   * </pre>
   * 
   * @since 4.6
   */
  private int resultCalculation(int firstNumber, int secondNumber) {
    return number1 + number2;
  }

  /**
   *Lis
   * @throws java.io.IOException
   *Erreur d'E / S
   */
  public void readFromFile() throws IOException{

  }
}

Résumé

――Cette fois, comme c'est la deuxième méthode de code, j'écrirai un article en me remémorant l'époque où j'ai eu le sentiment de tomber amoureux de "la création automatique de documents dans un format spécifié". «Je serais heureux si je pouvais faire quoi que ce soit avec le minimum de demandes dans tout», et je ne devrais pas le laisser «sortir ensemble» même avec une punition. Je ne peux plus m'en empêcher. «Pour cette raison, je vis une vie restreinte, et je m'engage à accepter mon destin et à continuer à me consacrer au jeu fantastique et à l'enquête sur les déchets, etc. Je fais fièrement un serment inoubliable. ..

référence

  • https://www.javadrive.jp/javadoc/
    → J'ai fait référence à cet article. Merci pour toute l'aide que vous m'avez apportée.

Recommended Posts

[Mots qui m'ont été épelés lorsque j'étais en première année ⑪] Veuillez comprendre la méthode de codage Java minimale. (2ème: édition Javadoc)
[Mots qui m'ont été épelés lorsque j'étais en première année ⑩] Veuillez comprendre la méthode de codage Java minimale. (1er: dénomination)
[Mots qui m'ont été écrits lorsque j'étais en première année ⑦] Ce que je veux que vous incluiez au moins avec l'extension Visual Studio Code
Quand j'ai voulu créer une méthode pour Premium Friday, c'était déjà dans l'API standard Java 8
Je souhaite obtenir l'adresse IP lors de la connexion au Wi-Fi avec Java
Référence Java à comprendre dans la figure
J'étais accro à la méthode du rouleau
[Promotion de la compréhension de Ruby (1)] Lorsque vous passez de Java à Ruby, commencez par comprendre la différence.
La partie à laquelle j'étais accro dans "Introduction à Ajax dans les applications Web Java" de NetBeans
J'étais accro à NoSuchMethodError dans Cloud Endpoints
Classes et instances Java comprises dans la figure
J'ai essayé d'implémenter la méthode de division mutuelle d'Eugrid en Java
Comment initialiser par lots des tableaux avec Java que je ne savais pas quand j'étais débutant