Ces exemples illustrent certaines lignes de code commentées. Plate-forme Java, pas particulière à l`Oracle JDK ou SDK, nous avons abandonné «JDK». Notez que la spécification n`a pas besoin d`être entièrement contenue dans les commentaires doc. Omettre les parenthèses pour la forme générale des méthodes et des constructeurs lors de la référence à une méthode ou un constructeur qui a plusieurs formulaires, et vous voulez faire référence à un formulaire spécifique, utilisez des parenthèses et des types d`arguments. Nos commentaires de documentation définissent la spécification d`API de plate-forme Java officielle. Commentant à l`aide de n`importe quel éditeur de texte. Nous consacrons du temps et des efforts à spécifier les conditions des limites, les plages d`arguments et les cas de coin plutôt que de définir des termes de programmation communs, d`écrire des aperçus conceptuels et d`inclure des exemples pour les développeurs. Incluez le mot «méthode» pour le distinguer comme une méthode et non comme un champ. Lorsque vous exécutez le fichier M, les lignes commentées ne s`exécutent pas. Ces images ne sont plus nécessaires en commençant par 1.
Ajoutez des commentaires dans un fichier M pour décrire le code ou comment l`utiliser. Le Doclet standard de Javadoc affiche une sous-position «since» avec l`argument de chaîne comme son texte. Dénomination des images doc dans l`arborescence source-nom images GIF -1. Dans les deux premiers cas, si une méthode m () substitue une autre méthode, l`outil Javadoc générera une sous-position «remplacements» dans la documentation de m (), avec un lien vers la méthode qu`il remplace. Kameenui, E. Par exemple: «fournit des classes et des interfaces pour gérer le texte, les dates, les nombres et les messages d`une manière indépendante des langages naturels. Voici un exemple de ceci (où «final» et «Synchronization» sont supprimés pour simplifier la comparaison). Section 8. Les opérateurs% {et%} doivent apparaître seuls sur les lignes qui précèdent immédiatement et suivent le bloc de texte d`aide. Soyez clair lorsque vous utilisez le terme «champ».
En particulier, écrire des phrases récapitulatives qui distinguent les méthodes surchargées les unes des autres. Incluez des références à des documents qui ne contiennent pas d`assertions de spécification, telles que des aperçus, des didacticiels, des exemples, des démos et des guides. Dymock, S. Cette déclaration explicite vous donne également un endroit pour écrire des commentaires de documentation. Première phrase la première phrase de chaque commentaire de doc doit être une phrase récapitulative, contenant une description concise mais complète de l`élément de l`API. Pour plus de détails, consultez documentation des exceptions avec la balise @throws. Lapp, J. scripts Live et fonctions (. En d`autres termes, les exceptions de document qui sont indépendantes de l`implémentation sous-jacente. Dans d`autres cas qui peuvent varier avec les implémentations sur une plate-forme, vous pouvez utiliser l`expression Lead-in «implémentation-specific:». Vous pouvez inclure toute ou toutes ces informations dans les commentaires de documentation (et peut inclure des balises personnalisées, gérées par un Doclet personnalisé, pour le faciliter). Comme cette balise ne peut être appliquée qu`à la vue d`ensemble, au niveau du package et de la classe, la balise s`applique uniquement à ceux qui contribuent de manière significative à la conception ou à la mise en œuvre, ce qui n`inclut pas habituellement les rédacteurs techniques.
Un commentaire de doc approprié devrait alors être fourni. Problème-un problème se produit si vous travaillez dans un éditeur qui par défaut à des guillemets simples et doubles bouclés (plutôt que droits), tels que Microsoft Word sur un PC–les guillemets disparaissent lorsqu`ils sont affichés dans certains navigateurs (tels que Netscape UNIX). Commentant utilisation de l`éditeur/débogueur MATLAB.