Code Java commentaires des meilleures pratiques

J'ai finalisé mon Java/Android projet et maintenant, j'ai besoin de commenter les codes (principalement les classes et méthodes).

J'ai besoin de le faire en suivant les meilleurs standards industriels comme plus tard si quelqu'un d'autre le besoin de le modifier, il doit être bien straight forward.

J'ai lu de nombreux articles et a trouvé 3 principaux types de java, en commentant les styles.

  1. Commentaire d'une ligne (//.....)
  2. Bloquer les commentaires (/* ....... */)
  3. Doc commentaires (/** ....... */)

J'ai lu principalement sur l'option 2 et 3. Un débordement de pile discussions

Alors j'ai pensé à aller à la 2ème option que je n'ai pas besoin de générer du HTML docs que ces classes ne vont pas à utiliser par tous les autres gens, et c'est la mise en œuvre de cette application.

Se demander quelles sont les meilleures pratiques dans le bloc de commentaires indiquant "retour", "paramètres" et "obtenir de brèves description" de la méthode ou de la classe.

Aimerions connaître les meilleures pratiques standard de l'industrie de la code java commentaires.

Merci d'avance...!!!

Ce n'est pas un doublon avec ce que je suis en demandant au sujet de la meilleure manière industrielle pour aller avec l'option 2 dans ma question.... En gros, si une méthode a plusieurs paramètres comment expliquer au sujet de chaque (Comme @param est-il dans la doc commentaires). Aussi les types de retour, etc....
juste assez, commentaire supprimé.

OriginalL'auteur JibW | 2014-04-03