Skip to topic | Skip to bottom
Home
Minfo04
Minfo04.JadaptoRConventionsr1.2 - 06 May 2005 - 17:18 - FerutTerencetopic end

Start of topic | Skip to actions

JAdaptor - Conventions adoptées

Commentaire du code

le code doit être commenté intégralement, et d'abord en anglais. Il est souhaité d'y ajouter également des commentaires équivalents en français.

Par convention nous entrerons d'abord les commentaires anglais, puis après avoir sauté une ligne l'équivalent en français, en italique. Pour les paramètres et les valeurs de retour, idem en anglais d'abord puis, à la suite, les commentaires en français en italique.

Voici un exemple de code commenté valide pour notre convention :
/**
* remove the phasis t to the vector if it contains it<.br><.br>
*
* <.i>retire la phase t du vecteur, s'il la contient.<./i>
*
* @param t phasis to remove - <.i>phase à retirer<./i>
*/
public void removePhasis (Phasis t) {
if (phasis.contains(t))
phasis.remove(t) ;
}

Pour que les balises restent visibles et ne soient pas interprétées par Wiki, toutes les balises incluses dans les commentaires commencent ici par un point, qui évidemment disparaitra dans les commentaires du code.
Attention : pensez bien à ne pas mettre de point '.' dans les lignes de description des méthodes, sinon javadoc considère ça comme la fin de la description et ignore la suite.

L'adoption de cette convention rend beaucoup plus lisibles les pages web produites par la javadoc.



to top

You are here: Minfo04 > JadaptoRConventions

to top

Copyright © 1999-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding WIKIDeptinfo? Send feedback