Quelle est la méthode de commentaire la plus communément acceptée ou est-ce vraiment important?Conventions de commentaire Java
J'utilise
/**
* (Method description)
* @param
* @return
* etc
*/
Cependant, j'ai lu:
Precondition:
Postcondition:
Y at-il une façon plus 'professionnelle' de commenter?
Voici les conventions de codage Java pour commentaires recommandés par Oracle:
Voici les recommandations de Google pour leur plate-forme Android:
Pour plus d'informations sur le style et les conventions pour Javadoc, voir ici:
Le lien aux recommandations Google semble être allé ou restreint. Peut-être que c'est le remplacement? http://source.android.com/source/code-style.html#use-javadoc-standard-comments –
Je pense que les conventions Javadoc sont les meilleures. Est-ce que quelqu'un a les recommandations d'Oracle pdf ou une nouvelle adresse? –
Le style de commentaire dans votre premier exemple est non seulement une convention, il est une norme pour un outil de documentation appelé Javadoc. Si vous suivez ce style de commentaire Javadoc, vous pourrez facilement générer une documentation au format HTML pour l'ensemble de votre code source.
Je suivrais simplement la norme définie par Sun (Oracle) pour l'écriture de Javadoc. Javadoc est référé par tous les développeurs à l'unanimité :). Pour plus d'informations, cliquez sur here
Je vous demanderais également de faire suite search on Stackoverflow pour beaucoup de questions et de réponses sur commentant.
lien This est très utile et j'utilise ce depuis longtemps et m'a beaucoup aidé. Cela crée un code très bon et documenté avec une capacité de lecture maximale.
Tout d'abord, avoir un code lisible et des commentaires lisibles sont deux choses totalement différentes.
Code Lisible est le code des usages bien variables, la méthode, les noms de classes, etc.
commentaires déchiffrable plus une question de goût personnel. Certaines personnes aiment les commentaires pour suivre les règles grammaticales qui seraient utilisées pour écrire un livre alors que d'autres se foutent des choses grammaticales. Vous pouvez passer par ce lien:
http://www.oracle.com/technetwork/java/codeconventions-141999.html#385
De code lisible et les commentaires, vous pouvez créer des documents avec l'aide de doxygen.
double possible de [Commentant les conventions] (http://stackoverflow.com/questions/999431/commenting-conventions) – krock