Bugzilla – Full Text Bug Listing
| Summary: | Javadoc shouldn't be required for getters / setters | ||
|---|---|---|---|
| Product: | [Eclipse Project] JDT | Reporter: | Johan Walles <johan.walles> |
| Component: | Core | Assignee: | JDT-Core-Inbox <jdt-core-inbox> |
| Status: | RESOLVED WONTFIX | QA Contact: | |
| Severity: | enhancement | ||
| Priority: | P3 | ||
| Version: | 3.1 | ||
| Target Milestone: | 3.1 M5 | ||
| Hardware: | PC | ||
| OS: | Linux | ||
| Whiteboard: | |||
Compiler has no way to know that a method is a getter or a setter due to the fact that there's no real specification about this notion, only conventions. You can use Source>Add Comment to generate your Javadoc comment on getters/setters if does not already exist, so it is really easy to fix compiler warnings. Even if this generated comment is trivial and redundant, we cannot consider this point as a problem which should be hidden by a specific compiler option. |
I'm using 3.1M4. There is a warning I can enable for public methods without any Javadoc comments. I'd like to be able to enable that warning for all methods except getters with no parameters and setters with exactly one parameter. The reason is that in many cases the workings of a [g|s]etter is so obvious that a comment is just redundant: public String getName() { return this.name; }