Discussion :

[Goupo]

Salut à tous,

Suite à une revue de code, on me dit que je dois modifier les en têtes de mes classes. En effet, en l'état actuel, ça ne fait très pro, voir pas du tout pro :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */

Je n'ai jamais fait d'en têtes.
Ça n'a pas l'air bien compliqué mais quelqu'un a-t-il un exemple d'en tête à me montrer histoire de voir comment c'est habituellement fichu? Notamment, je me pose des questions sur le copyright.

Merci d'avance.

[zorm]

Regardes du coté des commentaires javadoc, ca te permettra en plus de pouvoir générer toutes la documentation de ton projet.

Je te copie le premier exemple trouvé pour te donner une idée:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
/**  Description du code dans un phrase complète.
  * @author <a href="http://www.le-site.com/">Jean  Dupondt</a>
  * @version 1.0 (2003-01-09)
*/

Le message que tu as dans ton code pour l'instant est une explication pour modifier le template d'autogénération de commentaire. Ca te permettra de pouvoir avoir un commentaire perso mis automatiquement à chaque nouvelle création

[Goupo]

Oui, pour l'histoire du Template, j'avais compris. Merci pour ton exemple.

De quelle manière est présenté un copyright dans ce cartouche? Existe-t-il un @copyright? Ca ne semble pas être le cas au vu de ce tutoriel.

[womannosky]

La norme Java pour les commentaires en début de classe est donnée par Sun :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
 
/**
*Nom de la classe + description
*
*Information sur la version de la classe (@version ...)
*
*Copyright notice (@author prénom nom)
*/

bon courage. A++

[Goupo]

Ok ça roule.
Merci!

Donc un truc comme ça par exemple ça le fait.

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
/**
 * IHM
 * 
 * La classe IHM est la classe principale
 * de l'interface utilisateur. Elle sert 
 * de cadre pour accueillir les différents 
 * écrans.
 * 
 * Copyright 25 Juin 2008 (@author Xxxx XXXX)
 * @version 1.0
 */