Can you document inJavadoc of a number of annotations that hey does not want static method?s
See original GitHub issueI work with Spring (Boot) and Eclipse. I enabled the warnings about methods that can be declared as static. The problem is Eclipse signals also methods decorated by @Autowired
and other Spring decorators that does not want a static method.
I reported the problem to Eclipse, but they say they can’t trust me, it must be documented in the Javadoc of the annotations.
Can you please add this information to the annotations that doesn’t want a static method?
Thank you in advance.
Issue Analytics
- State:
- Created 4 years ago
- Comments:5 (4 by maintainers)
Top Results From Across the Web
How to Write Doc Comments for the Javadoc Tool - Oracle
This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, ...
Read more >Java: Javadoc tags | I'd Rather Be Writing Blog
Write the description like this: @param count Sets the number of widgets you want included. @deprecated, Lets users know the class or method...
Read more >How to reference a method in javadoc? - Stack Overflow
Use the {@link #getComponentAt(int, int) getComponentAt} method. The module/package.class part can be ommited if the referred method is in the current class.
Read more >How to Use JavaDoc to Document Your Classes - Dummies.com
A step remains before you can go public with your hot new class library or application: preparing the documentation for its classes.
Read more >Mockito 3.12.1 API - javadoc.io
//If your code doesn't care what get(0) returns, then it should not be stubbed. ... Read more about spying: here or in javadoc...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Since most of the discussion of this happens on this bug at Eclipse: https://bugs.eclipse.org/bugs/show_bug.cgi?id=547451
I tend to close this issue here. Would that be fine with everybody involved?
Ok, so let me close this one here and continue the discussion on the Eclipse bug. I think having the whitelist that Stephan mentioned over there configurable would be the best choice and allow us and/or users to modify that list whenever it makes sense. We can also try to submit a PR for that whitelist with the most famous Spring annotations, maybe that is enough of an “official” thing from the Spring team. Let’s see.