Welche Konvention verwenden Sie, um Getter und Setter zu kommentieren? Das habe ich mir schon seit einiger Zeit gefragt:
/**
* (1a) what do you put here?
* @param salary (1b) what do you put here?
*/
public void setSalary(float salary);
/*
* (2a) what do you put here?
* @return (2b)
*/
public float getSalary();
Ich finde immer, dass ich für 1a / b und 2a / b genau dasselbe schreibe, so etwas wie 1a) Legt das Gehalt des Mitarbeiters fest, 1b) das Gehalt des Mitarbeiters. Es scheint einfach so überflüssig. Jetzt könnte ich für etwas Komplexeres sehen, dass Sie vielleicht mehr in die (a) Teile schreiben, um den Kontext zu geben, aber für die Mehrheit der Getter / Setter da draußen ist der Wortlaut fast genau der gleiche.
Ich bin nur neugierig, ob es für die einfachen Getter / Setter in Ordnung ist, nur entweder den (a) Teil oder den (b) Teil auszufüllen.
Was denken Sie?