Community
Participate
Working Groups
Code Formatter: There should be a way to set up the behaviour for every single Javadoc tag. E.g. "blank line before @return", "no blank line between tags of the same kind (as between @param and @param)", "blank line between different tags (as between @param and @return)", etc.
not for 3.0
For 3.0, could you please at least add the option "blank line between different tags" (as between @param and @return, @return and @throws), or make this preference the default without an option? I think, this is what most people format their comments like and as far as I know, this is how Sun suggests to do it. The missing lines really bother me heavily.
Ownership changed.
Ownership has changed for the formatter, but I surely will not have enough time to fix your bug during the 3.5 development process, hence set its priority to P5. Please provide a patch if you definitely need the bug to be fixed in this version and I'll have a look at it... TIA
I almost created a new bug :-) but luckily found this one in time. I believe there is good justification now to bump this ticket in priority.... JDK 8 introduced additional JavaDoc tags @apiNote, @implSpec and @implNote [1][2]. As demonstrated by the links and actual JDK source code [3], the preferred stylistic use of them is to place the tag annotation and the tag documentation on separate lines. Eclipse currently doesn't support this kind of formatting granularity. If it did, the "Blank line before Javadoc tags" option would be the right place for the enhancement. This request is to provide either an includes or excludes list by tag annotations. Relevant links: 1) http://openjdk.java.net/jeps/8068562 2) https://bugs.openjdk.java.net/browse/JDK-8008632 3) http://hg.openjdk.java.net/jdk9/jdk9/jdk/file/d9a44cfdeebf/src/java.base/share/classes/java/util/stream/Collectors.java
Addendum to comment #5: My preferred style is like the JDK source code, in which all tags (minus the aforementioned) are on the same line as the text. That's why this is an important request to me. In reverse, perhaps someone may find useful this enhancement for the opposite style.
(In reply to Paul Benedict from comment #5) > I almost created a new bug :-) but luckily found this one in time. I believe > there is good justification now to bump this ticket in priority.... > > JDK 8 introduced additional JavaDoc tags @apiNote, @implSpec and @implNote > [1][2]. As demonstrated by the links and actual JDK source code [3], the > preferred stylistic use of them is to place the tag annotation and the tag > documentation on separate lines. Well, you'll need to create a new bug then :) This bug is not about adding a line break between a tag name and its description, it's about adding a blank line (as in two consecutive line breaks) between tags. I'm going to implement the "blank line between tags of different type" option as suggested in comment 2.
New Gerrit change created: https://git.eclipse.org/r/152394
Gerrit change https://git.eclipse.org/r/152394 was merged to [master]. Commit: http://git.eclipse.org/c/jdt/eclipse.jdt.core.git/commit/?id=df3c3b099b3e029ccee729f45e972ec3d89f4f60
Verified for Eclipse Version: 2019-12 (4.14) M3 with Build id: I20191118-0600
