exemple d`un commentaire de document en histoire

15 Dec 2018 no comments alumni-jntuk@login

Les commentaires ne doivent pas documenter les bogues ou comment une implémentation qui est actuellement hors de spec arrive à travailler. Par Convention, le premier nom de la description est le type de données du paramètre. Cela peut constituer une explication du code, plutôt qu`une clarification de son intention; mais d`autres chargés de maintenir le code de base peut trouver une telle explication cruciale. Décrivez ce que contient le paquet et indiquez son but. Pour obtenir des exemples plus détaillés et des instructions complètes, consultez l`article Advanced Javadoc Guidelines. Il ne doit pas y avoir de position avant la première phrase, car l`outil Javadoc récupère le premier texte en tant qu`État récapitulatif. Ce qui suit est un code médiocre–puisque l`exception est un RuntimeException, il doit être documenté dans la balise @throws à la place. Outil Javadoc génère. Enfin, il y a (3) une section de balises pour répertorier les arguments d`entrée acceptés et les valeurs de retour de la méthode. À titre d`exemple, consultez la documentation Javadoc d`Oracle pour les bibliothèques Java à l`http://download. L`introduction du document: vous n`avez pas à suivre exactement la séquence des problèmes donnés ci-dessous. Certains d`entre eux sont informels et fondés sur des préférences personnelles, tandis que d`autres sont publiés ou promulgués comme lignes directrices formelles pour une communauté particulière. Une dernière note: pour être honnête (et ne dites à personne à ce sujet), dans mon cœur de cœur, je soupçonne que je crois que toute personne qui n`a pas lu “les éléments de style de programmation” ne devrait pas être autorisé à écrire du code.

Contenu du document: qu`est-ce que l`auteur discute (thème principal; thèmes secondaires: résumez-les brièvement mais à fond. Y a-t-il des contradictions? Consultez également les critères d`Oracle pour inclure des classes dans la spécification de formulaire sérialisée. Les images de puces et de titres requises avec la version 1 de Javadoc. La Convention Java Software pour l`argument de la balise @version est la chaîne SCCS “% I%,% G%”, qui se convertit en quelque chose comme “1. Commande de plusieurs balises nous employons les conventions suivantes lorsqu`une balise apparaît plus d`une fois dans un commentaire de documentation. Javadoc 1. Ce qui ne peut pas être déterminé en lisant le code–et ce qui est susceptible de rester constant à mesure que le code évolue–est la raison pour laquelle le code existe. Toutefois, étant donné qu`ils ne contiennent pas d`API «assertions», ils ne sont pas nécessaires dans une spécification d`API.

En particulier, les spécifications qui sont longues sont parfois mieux formatées dans un fichier distinct et lié à partir d`un commentaire doc. Cela peut prendre deux formes différentes: les bogues de spécification d`API et les bogues de code. Si ce n`est pas le cas, mais vous souhaitez toujours générer du code HTML pour voir à quoi il ressemble, ajoutez la syntaxe ci-dessus suivie par les packages que vous souhaitez générer. Si le commentaire de doc répète simplement le nom de l`API sous forme de phrase, il ne fournit pas plus d`informations.