[JAVA] Notes sur la façon de rédiger des commentaires en anglais

introduction

Étant donné que les commentaires du programme sont essentiellement écrits en anglais Faites une note pour vous-même

Commentaire d'en-tête de classe

Classe de système contenant des informations

/**
 * This class is used to hold the ***.
 */

Classe de système à fournir

/**
 * Provides ***.
 */

Classe d'interface

/**
 * Defines a *** interface.
 * That any implementation of this interface can be used by inheritor's to handle a ***.
 */

Commentaire de méthode

Paramètre de drapeau lié

/**
 * Sets flag indicating whether *** is ***.
 */

Relation de jugement

/**
 * Determines if *** is *** or not.
 *
 * @return Returns {@code true} if *** is ***, {@code false} otherwise.
 */

Relation de jugement 2

/**
 * Checks whether the given *** can be ***.
 *
 * @return Returns {@code true} if the given *** can be ***, {@code false} if they cannot be ***.
 */

Relation pour obtenir quelque chose

/**
 * Gets the *** with the given {@code ***}.
 *
 * @return Returns the ***. Returns {@code null} if *** doesn't have a specified ***.
 */

Autre

système enum

/**
 * Enumeration for ***.
 */

Recommended Posts

Notes sur la façon de rédiger des commentaires en anglais
Comment rédiger un commentaire java
[Ruby on Rails] Comment écrire enum en japonais
Remarques sur l'utilisation des expressions régulières en Java
Comment écrire des rails
JUnit 5: Comment écrire des cas de test dans enum
Notes sur l'utilisation de chaque règle de JUnit
Comment écrire docker-compose
Comment écrire Mockito
Comment écrire un fichier de migration
[Java] Mémo sur la façon d'écrire la source
Comment écrire Java String # getBytes dans Kotlin?
Remarques sur la création d'extensions Burp Suite
Javaer résume comment écrire des propriétés C #
[Java] Types de commentaires et comment les rédiger
[Ruby On Rails] Comment réinitialiser DB dans Heroku
Comment écrire une recherche de comparaison de dates dans Rails
Comment écrire un mod de base dans Minecraft Forge 1.15.2
Comment écrire du bon code
Comment déployer avec heroku
[Refactoring] Comment écrire le routage
Comment écrire Junit 5 organisé
Comment écrire des graines de Rails
Comment écrire le routage Rails
Comment écrire et noter lors de la migration de VB vers JAVA
Comment changer Java à l'ère d'OpenJDK sur Mac
[Rails 5] lien japanMap Comment écrire des paramètres dans le fichier js.erb
[Rails] Comment écrire user_id (clé externe) dans un paramètre fort
Comment écrire des commentaires dans le fichier de définition de schéma dans GraphQL Java et les refléter dans GraphiQL et GraphQL Playground
Comment utiliser Lombok au printemps
Comment trouver May'n dans XPath
Comment masquer la barre de défilement dans WebView
Comment exécuter JUnit dans Eclipse
Comment itérer indéfiniment en Ruby
Étudier Java # 6 (Comment écrire des blocs)
Comment "évider" une vue sur Android
Comment exécuter Ant dans Gradle
Comment maîtriser la programmation en 3 mois
Comment utiliser Ruby on Rails
Comment déployer Bootstrap sur Rails
Pour exécuter JavaFX sur Docker
Comment apprendre JAVA en 7 jours
Comment obtenir des paramètres dans Spark
Comment utiliser les bio-formats sur Ubuntu 20.04
Comment installer Bootstrap dans Ruby