Maison Java javaDidacticiel Essai d'introduction aux bases de Java (9) Édition JavaSE - Commentaires sur la documentation

Essai d'introduction aux bases de Java (9) Édition JavaSE - Commentaires sur la documentation

Dec 22, 2016 pm 01:15 PM

Dans la section précédente, nous avons parlé de la définition et de l'utilisation de certaines variables statiques et méthodes statiques, ainsi que des différences entre elles et non statiques. Cette section ajoute :

Si toutes les méthodes sont dans un. sont statiques et il n'y a pas de variables membres, pour le moment, vous devez restreindre la classe correspondante. Cette classe ne peut pas créer d'objets. Les opérations spécifiques sont les suivantes :

PRivate ArrayTool(){}

.

//Les méthodes de cette classe sont toutes statiques, cette classe n'a donc pas besoin de créer d'objets. Afin d'empêcher d'autres personnes de créer des objets de cette classe, vous pouvez rendre le constructeur de cette classe privé.

1. Commentaires de documentation

Utilisez l'outil javadoc dans la fausse machine Java pour générer des commentaires de documentation et utilisez les commentaires de documentation dans le code pour les générer.

Remarque :

1. Chaque unité de compilation (fichier de classe) ne peut avoir qu'une seule classe publique
2. Le nom de la classe publique (y compris les majuscules et les minuscules) doit être le identique à son fichier de classe Même nom.
3. La classe publique n'a pas besoin d'exister dans un fichier de classe (*.java).

Utilisez la balise javadoc :

La balise javadoc se compose de "@" suivi du type de balise et de la référence d'annotation spéciale
Les balises javadoc incluent les éléments suivants :
Désignation de l'auteur @ L'auteur qui a développé ce type de module
@version indique la version de ce type de module
@voir Pilotage de référence, c'est-à-dire les sujets connexes
@param Description d'un certain paramètre dans la méthode
@return Valeur de retour de la méthode Description de
@exception explique les exceptions qui peuvent être levées par la méthode

Ce qui précède est le contenu de l'essai d'introduction aux bases de Java (9) Édition JavaSE - Commentaires de documentation pour. Pour plus de contenu connexe, veuillez faire attention au site Web PHP chinois ( www.php.cn) !


Déclaration de ce site Web
Le contenu de cet article est volontairement contribué par les internautes et les droits d'auteur appartiennent à l'auteur original. Ce site n'assume aucune responsabilité légale correspondante. Si vous trouvez un contenu suspecté de plagiat ou de contrefaçon, veuillez contacter admin@php.cn

Outils d'IA chauds

Undresser.AI Undress

Undresser.AI Undress

Application basée sur l'IA pour créer des photos de nu réalistes

AI Clothes Remover

AI Clothes Remover

Outil d'IA en ligne pour supprimer les vêtements des photos.

Undress AI Tool

Undress AI Tool

Images de déshabillage gratuites

Clothoff.io

Clothoff.io

Dissolvant de vêtements AI

Video Face Swap

Video Face Swap

Échangez les visages dans n'importe quelle vidéo sans effort grâce à notre outil d'échange de visage AI entièrement gratuit !

Outils chauds

Bloc-notes++7.3.1

Bloc-notes++7.3.1

Éditeur de code facile à utiliser et gratuit

SublimeText3 version chinoise

SublimeText3 version chinoise

Version chinoise, très simple à utiliser

Envoyer Studio 13.0.1

Envoyer Studio 13.0.1

Puissant environnement de développement intégré PHP

Dreamweaver CS6

Dreamweaver CS6

Outils de développement Web visuel

SublimeText3 version Mac

SublimeText3 version Mac

Logiciel d'édition de code au niveau de Dieu (SublimeText3)

Comment annoter des fonctions PHP avec des commentaires de documentation ? Comment annoter des fonctions PHP avec des commentaires de documentation ? Apr 11, 2024 pm 04:48 PM

Les commentaires de la documentation PHP sont utilisés pour annoter les fonctions et contiennent les champs obligatoires suivants : description, paramètres (@param) et valeur de retour (@return). Les champs facultatifs incluent : les exceptions (@throws), la version d'introduction (@since) et les exemples d'utilisation (@example). Utilisez l'outil PHPDocumentor pour générer une documentation HTML afin d'afficher les fonctions annotées.

Commentaires de code en PHP Commentaires de code en PHP May 23, 2023 am 08:27 AM

Les commentaires de code sont des rappels textuels que les programmeurs ajoutent lors de l’écriture du code pour faciliter la lecture et la compréhension du code par eux-mêmes et par les autres programmeurs. En PHP, les commentaires de code sont indispensables. Cet article présentera en détail les types, spécifications et utilisations des commentaires de code en PHP. 1. Types de commentaires de code en PHP En PHP, il existe trois types de commentaires : les commentaires sur une seule ligne, les commentaires sur plusieurs lignes et les commentaires de documentation. Commentaires sur une seule ligne Un commentaire sur une seule ligne commence par une double barre oblique "//" et se termine à la fin de la ligne. Par exemple : //Il s'agit d'un commentaire sur une seule ligne. Commentaire sur plusieurs lignes. Le commentaire sur plusieurs lignes se termine par "

La relation complémentaire entre les commentaires de la documentation et les conventions de dénomination dans la dénomination des fonctions C++ La relation complémentaire entre les commentaires de la documentation et les conventions de dénomination dans la dénomination des fonctions C++ May 03, 2024 am 09:00 AM

Les conventions de dénomination des fonctions et les commentaires de documentation en C++ se complètent et améliorent la lisibilité du code. Les conventions de dénomination fournissent des noms de fonctions clairs et cohérents, tandis que les commentaires de la documentation complètent les détails tels que leur objectif, leurs paramètres, leurs valeurs de retour et leurs conditions préalables, garantissant ainsi que le code est facile à comprendre, à maintenir et à étendre.

Débutants Java : Comment définir le stade d'entrée ? Débutants Java : Comment définir le stade d'entrée ? Feb 18, 2024 pm 06:29 PM

Débuter avec Java : à quelle étape de l'apprentissage est-on débutant ? En tant que langage de programmation largement utilisé dans le domaine du développement de logiciels, Java est facile à apprendre, multiplateforme et hautement sécurisé, il est donc très populaire parmi les programmeurs. De nombreux débutants espèrent démarrer avec Java le plus tôt possible et commencer leur parcours de programmation. Alors, comment jugeons-nous que nous avons débuté avec Java et quelle étape avons-nous apprise ? Tout d’abord, nous devons clarifier un concept : débuter ne signifie pas maîtriser. La mise en route ne complète que la compréhension et la maîtrise préliminaires du langage Java.

Prérequis importants pour apprendre la technologie Java : comprendre les concepts de base et les outils d'application Prérequis importants pour apprendre la technologie Java : comprendre les concepts de base et les outils d'application Jan 13, 2024 pm 03:02 PM

Connaissances essentielles pour apprendre la technologie Java : maîtriser les concepts clés et les outils de développement, et nécessiter des exemples de codes spécifiques. Java est un langage de programmation informatique largement utilisé dans le domaine du développement logiciel. Sa puissance réside dans ses fonctionnalités multiplateformes et sa riche prise en charge d'outils de développement, faisant de Java l'un des langages de programmation les plus populaires aujourd'hui. Si vous souhaitez apprendre la technologie Java, la maîtrise de certains concepts clés et outils de développement est indispensable. Cet article vous présentera quelques connaissances Java essentielles et vous fournira quelques exemples de code spécifiques pour mieux vous aider.

Partage de méthodes d'apprentissage efficaces pour les connaissances de base JAVA Partage de méthodes d'apprentissage efficaces pour les connaissances de base JAVA Nov 08, 2023 pm 06:44 PM

JAVA est un langage de programmation orienté objet largement utilisé dans le domaine du développement de logiciels. La maîtrise et l'utilisation compétente des connaissances de base de JAVA sont cruciales pour les programmeurs. Cela peut améliorer l'efficacité du développement et rendre le code plus fiable et plus facile à maintenir. Cet article partagera plusieurs méthodes pour apprendre efficacement les connaissances de base de JAVA et fournira des exemples de code spécifiques. 1. Étapes de base pour apprendre les connaissances de base de JAVA Pour apprendre un nouveau langage de programmation, vous devez d'abord maîtriser sa syntaxe et ses fonctionnalités de base. Pour JAVA, vous pouvez lire des tutoriels ou des livres pertinents

Spécification des commentaires PHP : Comment utiliser les commentaires de la documentation pour rédiger la documentation de l'API Spécification des commentaires PHP : Comment utiliser les commentaires de la documentation pour rédiger la documentation de l'API Jul 30, 2023 pm 07:00 PM

Spécification des commentaires PHP : Comment utiliser les commentaires de documentation pour rédiger la documentation de l'API Introduction : Lors du développement d'applications PHP, la rédaction d'une documentation API complète est très importante pour l'équipe de développement et les autres développeurs. Une bonne documentation améliore la lisibilité et la maintenabilité du code, et favorise le travail d'équipe et le partage d'informations. Cet article explique comment utiliser les commentaires de documentation pour rédiger la documentation de l'API PHP et fournit des exemples de code pour aider les lecteurs à comprendre comment rédiger des commentaires de manière standardisée. Spécification des commentaires En PHP, nous utilisons des commentaires pour expliquer et décrire le code. en général

Comment clarifier les exigences et les recommandations des dernières spécifications du code PHP dans les documents de projet et les commentaires de documentation ? Comment clarifier les exigences et les recommandations des dernières spécifications du code PHP dans les documents de projet et les commentaires de documentation ? Sep 05, 2023 pm 02:16 PM

Comment clarifier les exigences et les recommandations des dernières spécifications du code PHP dans les documents de projet et les commentaires sur la documentation ? Introduction : Lors du développement de projets PHP, il est très important de suivre des spécifications de code unifiées. De bonnes spécifications de code peuvent améliorer la lisibilité et la maintenabilité du code, réduire les erreurs de codage et améliorer l’efficacité de la collaboration en équipe. Afin de garantir la qualité du code du projet, l'équipe de développement doit clarifier les dernières exigences et recommandations des spécifications du code PHP. Dans cet article, nous décrivons comment rendre explicites ces exigences et recommandations dans la documentation du projet et les commentaires de la documentation, illustrés par des exemples de code.

See all articles