Discussion :

[ben.IT]

Bonsoir à tous,
lorsque je génère ma javadoc, il ne figure que les méthodes et pas les attributs, ce qui est génant. Comment faire pour faire apparaitre les attributs dans la javadoc ? J'utilise le dernier Eclipse Galileo et le JDK 6.

Voici un exemple d'une de mes classes :

Code :

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
 
public abstract class Result {
 
	private User reader;
 
	/**
         * Must have the right to review the first reading
         */
	private User reviewer;
 
	/**
         * Must have the right to interpret
         */
	private User validator;
	/**
         * if the result has been validated
         */
	private boolean validated;
	/**
         * the result interpretation
         */
	private String interpretation;
	/**
         * Constructor for a result
         * @param reader
         * @param reviewer
         * @param validator
         * @param interpretation
         */
	public Result(User reader, User reviewer, User validator, String interpretation) {
		// Bouml preserved body begin 0002EE02
		this.reader = reader;
		this.reviewer = reviewer;
		this.validator = validator;
		this.interpretation = interpretation;
		this.validated=false;
		// Bouml preserved body end 0002EE02
	}
 
	/**
         * print on the standard output the result attributes
         * @return the string printed with the different information. 
         */
	public String showResult() {
		// Bouml preserved body begin 0002EE82
		String s = new String("");
		s+="id reader : "+ getReader();
		s+="id reviewer : "+getReviewer();
		s+="id validator : "+getValidator();
		s+="interpretation : "+getInterpretation();
		return s;
		// Bouml preserved body end 0002EE82
	}
 
	/**
         * check if the reviewer isn't the same person as the reader.
         * @return true : if different, else : false
         */
	public boolean checkReviewer() {
		return(this.reader.getId()!=this.reviewer.getId());
	}
 
	public final Person getReader() {
		return reader;
	}
 
	public void setReader(User value) {
		reader = value;
	}
 
	public final User getReviewer() {
		return reviewer;
	}
 
	public void setReviewer(User value) {
		reviewer = value;
	}
 
	public final User getValidator() {
		return validator;
	}
 
	public void setValidator(User value) {
		validator = value;
	}
 
	public final boolean getValidated() {
		return validated;
	}
 
	public void setValidated(boolean value) {
		validated = value;
	}
 
	public final String getInterpretation() {
		return interpretation;
	}
 
	public void setInterpretation(String value) {
		interpretation = value;
	}
 
}

merci d'avance
benilto

[Deadpool]

Salut.

C'est pas tant que l'outil javadoc ne documente pas les attributs, c'est surtout que par défaut, il ne documente pas les membres privés d'une classe.

Après tout, la javadoc est le mode d'emploi d'une classe, et les membres privés n'étant pas visibles de l'extérieur par définition, ils n'auraient rien à y faire, puisqu'ils représentent des détails d'implémentation qui ne regarde que ta classe.

M'enfin, malgré tout une option de la javadoc le permet, l'option -private.

Exemple :

Code :

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

javadoc -d docProjet -private sources/*.java

Dans l'assistant de génération de Javadoc d'Eclipse, cela revient à sélectionner le bouton radio Private pour le champ "Create Javadoc for member with visibility".

[ben.IT]

oups, merci j'avais pas vu.

merci en tous cas !