javadoc - Private member variables in Java docs -


Specified descriptions of the private member variables used by Gates / Setters in Jawadox, which describe the recipient and the setter should be there.

Description of personal variable, like here:

  / ** * Name of this object * / personal string name;   

... should not have details of its gates and setters. It should include the properties of this variable, the inorient (such as should never be blank ), and similar.


Edit: Ah, I forgot your question. You were asked to explain why variables should be described in the details of the gates / sets, not the other way.

They should not - even such a variable does not exist, the gates and the satars should describe their effect, in which the amendment of some abstract properties of this object (Or retrieval) This property is implemented by a private variable is not relevant.

Comments