|
Les commentaires sont un outil puissant. Ils peuvent être utilisés pour générer Application Programming Interface ( API ) documentations entières avec des outils comme javadoc , lui donner de petites astuces dans les parties difficiles de code , ou tout simplement décrire ce que le code est sur le point de le faire . Quand vous laissez des commentaires dans le code Java, vous pouvez également afficher un lecteur qui ne connaît pas la langue exactement ce que fait le code . Instructions
1 laisser des commentaires courts, une seule ligne de dire quelque chose rapidement avant un petit groupe de lignes . Petit aperçu commentaires ce qui se fait en général " morceaux ". Un programmeur sera souvent écrire ces commentaires première et revenir à remplir dans le code par la suite , l'aider à cimenter son image mentale de la façon dont le code fonctionne avant de l' écrire, ainsi que d'identifier des failles dans la logique avant d'écrire le code.
2 connaître le format de laisser des commentaires une seule ligne. Ils sont signalés par "//" "" //Connexion à la serverSocket s = new TCPSocket (); s.connect . ( "Example.com" , 80) ;//Demander au files.write ("GET /HTTP /1.0 \\ r \\ n \\ r \\ n "); réponse de chaîne = s.read ( ) ;//la demande a été couronné de succès int code = get_code (réponse) ; ? ! if ( code = 200) return -1 ;//Télécharger le filedownload_file (s) »,«
3 Utilisez commentaires sur plusieurs lignes lorsque vous avez plus de dire que s'intégrera dans une seule ligne. Les commentaires multi - lignes se trouvent généralement dans le haut de méthodes décrivant la fonction globale , comment il fonctionne et quels sont les paramètres qu'il faut. Ils sont aussi parfois observés dans des parties localisées du Code du programmeur eu des ennuis avec ou pense mandat discussion en profondeur .
4 Notez que le format général des commentaires sur plusieurs lignes . Par convention, chaque ligne commence par un astérisque. Les exigences de format spécifiques ne sont que le commentaire commence par /* et se termine par * /. "" /* Cette partie a été vraiment difficile. Je devais * pirater cette valeur pour l'accommoder avec les autres. * Peut-être que je reviendrai à ce code pour trouver * une meilleure façon de le faire, mais pour * Maintenant cela fonctionne, mais ce n'est pas assez . * /""
5 connaître le format des commentaires Javadoc . Ils commencent par /** et contiennent des méta-tags qui ressemblent @ ce . Les commentaires Javadoc se trouvent principalement avant les méthodes . "" /*** Calcule la pente d'une ligne . ** @ Author Jack Smith * @ param p1 Premier point qui décrit la ligne * @ param p2 Deuxième point qui décrit la ligne * @ return Pente de la droite comme un float * /""
|
