Il n`y a aucun différend que ceux-ci contribuent à la compréhension d`un développeur et aider un développeur à écrire des applications fiables plus rapidement. La plupart des balises suivantes sont spécifiées dans la spécification du langage Java, première édition. Si le membre n`a pas de remplacement, l`argument à @deprecated devrait être «aucun remplacement». À cette fin, notre public cible est ceux qui écrivent des tests de compatibilité Java, ou se conforment ou réimplémentent la plate-forme Java, en plus des développeurs. Vous avez versé d`innombrables heures dans un projet, mais vos collègues ne l`utiliseront pas. Outil Javadoc génère. Ce fichier est conservé dans le répertoire source ainsi que tous les *. Cela rend important d`écrire des phrases initiales nettes et informatives qui peuvent se tenir sur leur propre. Classe de bouton. Il est utile de décider à l`avance si vous souhaitez les documenter dans les commentaires doc. Vous l`exécutez sur le code source et il génère un rapport décrivant les erreurs de style et de balise que les commentaires ont, et recommande les modifications. Lorsque vous le modifiez et le delget, il incrémente à 1. Création de votre propre tutoriel interactif n`est pas facile, mais il abaisse considérablement la barre pour essayer et apprendre sur votre projet.

Avec Javadoc 1. Par exemple, la plupart des commentaires javadoc pour les méthodes incluent les balises «@param» et «@return», le cas échéant, pour décrire les paramètres de la méthode et la valeur de retour. Il doit contenir une brève description lisible des installations fournies par le colis (dans l`introduction, ci-dessous) suivie de pointeurs vers la documentation détaillée, ou la documentation détaillée elle-même, selon le cas. Ces systèmes contiennent beaucoup d`informations sur le projet: ce que vous avez travaillé avant, ce que vous travaillez sur maintenant, ce que vous travaillerez dans l`avenir, les bogues trouvés, bugs corrigés, et ainsi de suite. Utilisez la même majuscule et la même ponctuation que celles utilisées dans @param. Lorsque vous créez un fichier,% I% est défini sur 1. C`est juste comme un bon régime et de l`exercice-vous le ferez quand vous avez le temps! Cette balise permet un exemple de code dans un commentaire, pour spécifier comment une méthode ou un autre membre de bibliothèque peut être utilisé. Documenter votre code est crucial pour aider les autres à le comprendre, et même pour vous rappeler comment fonctionnent vos propres programmes plus anciens. Incluez le mot «méthode» pour le distinguer comme une méthode et non comme un champ.

Il est composé de deux parties-une description suivie par des balises de bloc. En bref: toujours utiliser des commentaires avec modération et toujours pour expliquer pourquoi. Ce générateur peut être, mais ne doit pas être, le compilateur C# lui-même. Les sites Web de projet autonomes sont un excellent exemple de la documentation en tant que marketing: vous pouvez donner à votre projet sa propre maison, avec un aspect personnalisé et le contenu qui est Linkable, tweetable, et indexable. La méthode Add (int, Object) ajoute un élément à une position spécifiée dans cette ArrayList. Pour les projets open source populaires, une partie de la meilleure documentation se présente sous la forme de contenu fourni par la communauté. Exemple: une capture d`écran d`un bouton, Button-1. Voir «Man SCCS-get» pour plus de détails. Utilisez