[Java] Types de commentaires et comment les rédiger

: débutant: Je l'ai souligné à chaque fois dans la revue des sources de la formation des nouveaux arrivants, alors je l'ai organisée pour les nouveaux arrivants: débutant:

Types de commentaires Java

Comment rédiger un commentaire sur une ligne

//commentaire

Avec eclipse, vous pouvez l'ajouter ou le supprimer avec ctrl + /.

Comment rédiger un commentaire sur plusieurs lignes

/*
*Un astérisque au début
* comment
*/

JavaDoc

/**
 *Description de la classe ou de la méthode
 *Il y a deux astérisques au début.
 */

Un commentaire spécial avec une nature différente des deux mentionnés ci-dessus. Les commentaires JavaDoc peuvent être documentés à l'aide des commandes java = manuel de référence. Par conséquent, diverses balises peuvent être utilisées. C'est un manuel, donc ne l'utilisez pas lorsque vous écrivez une petite explication dans le code source.

Exemple de tag

marque La description
@param Description des paramètres (arguments).
@return Une description de la valeur de retour.
@author Une description du créateur du programme.
@throw Une description des exceptions levées.

Recommended Posts

[Java] Types de commentaires et comment les rédiger
Comment rédiger un commentaire java
Bases du développement Java ~ Comment écrire des programmes (variables et types) ~
[Java] Comment sortir et écrire des fichiers!
Promesse JDBC et exemple d'écriture
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 écrire Scala du point de vue de Java
Bases du développement Java ~ Comment écrire un programme (flux et branchement conditionnel) ~
Étudier Java # 6 (Comment écrire des blocs)
Comment écrire une déclaration de variable Java
Comparaison de l'écriture des fonctions de rappel (Java, JavaScript, Ruby)
Comment écrire et noter lors de la migration de VB vers JAVA
[java] Résumé de la gestion des caractères
Résumé de l'écriture des arguments d'annotation
[Introduction à Java] Comment écrire un programme Java
[Java] [Maven3] Résumé de l'utilisation de Maven3
[Introduction à Java] À propos des déclarations et des types de variables
Comment écrire un exemple d'implémentation Java d'un problème F01 en temps réel hors ligne
Java Beginner Escape Boot Camp Partie 1 Structure et écriture des classes Java
[Java] Notez comment utiliser RecyclerView et comment implémenter le traitement par balayage animé.
[Cas d'amélioration Java] Comment atteindre la limite de l'auto-apprentissage et au-delà
Java8 / 9 Beginners: Streaming API addiction points et comment les gérer
[Java] Comment utiliser la classe FileReader et la classe BufferedReader
[java] Résumé de la gestion des chaînes de caractères
Bases du développement Java ~ Comment écrire des programmes * Exercice 1 ~
[Java] Résumé de la façon d'omettre les expressions lambda
Comment obtenir et étudier Java SE8 Gold
[Java] Mémo sur la façon d'écrire la source
Comment écrire Java String # getBytes dans Kotlin?
Comment accéder aux méthodes et champs Java Private
Notes sur la façon de rédiger des commentaires en anglais
[Java] Comment utiliser la classe Calendar et la classe Date
Comment écrire des rails
java --Unification des commentaires
Comment écrire docker-compose
Comment écrire Mockito
Comment écrire un fichier de migration
[Java] Types de variables et types
Différence entre Java, C # et JavaScript (comment trouver le degré d'obésité)
[Java] Comment obtenir l'URL de la source de transition
[Rails, JS] Comment implémenter l'affichage asynchrone des commentaires
java: Comment écrire une liste de types génériques [Note]
[Java] Comment obtenir la valeur maximale de HashMap
Comment lire la gestion de la mémoire Java et GC Viewer
À partir d'avril 2018 Comment installer Java 8 sur Mac
Résumé de l'API de communication Java (1) Comment utiliser Socket
J'ai résumé les types et les bases des exceptions Java
Résumé de l'API de communication Java (3) Comment utiliser SocketChannel
Comment convertir A en A et A en A en utilisant le produit logique et la somme en Java
Résumé de l'API de communication Java (2) Comment utiliser HttpUrlConnection
Résumé de la mise en œuvre des arguments par défaut en Java
Comment écrire du Java moderne. Immuable Java, Null Considérez la sécurité.
Comparaison équivalente de la classe wrapper Java et du type primitif