方法上的属性导致javadoc中的空格

时间:2015-05-05 20:39:01

标签: java spring-mvc java-8 javadoc

我使用的是Java 8,我有一个弹簧控制器,它有一个创建新用户的方法:

/**
 * Creates a new user in the system
 * 
 * @param username The new user's username
 * @param email The new user's email
 * @param password The new user's password
 * @return the new user
 */
@RequestMapping(value = "/user/create", method = RequestMethod.POST)
@ResponseBody
public String createUser(
        @RequestParam(value = "username") String username,
        @RequestParam(value = "email") String email,
        @RequestParam(value = "password") String password) {
    return "";
}

当我为此生成javadoc时,我在参数之前得到了大量的空格。生成的HTML在列表中的参数之前的<pre>标记中有很多空格。

如果我从方法中删除了@RequestMapping@ResponseBody属性,那么javadoc就会按预期出现。

我已将javadoc工具生成的结果输出放在以下代码段中。第一个是今天的呈现方式,第二个是删除属性时它的正确显示方式。

&#13;
&#13;
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="createUser-java.lang.String-java.lang.String-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createUser</h4>
<pre>@RequestMapping(value="/user/create",
                method=POST)
 @ResponseBody
public&nbsp;java.lang.String&nbsp;createUser(@RequestParam(value="username")
                                                                                                                        java.lang.String&nbsp;username,
                                                                                                                        @RequestParam(value="email")
                                                                                                                        java.lang.String&nbsp;email,
                                                                                                                        @RequestParam(value="password")
                                                                                                                        java.lang.String&nbsp;password)</pre>
<div class="block">Creates a new user in the system</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>username</code> - The new user's username</dd>
<dd><code>email</code> - The new user's email</dd>
<dd><code>password</code> - The new user's password</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new user</dd>
</dl>
</li>
</ul>
<a name="createUserWithoutAttributes-java.lang.String-java.lang.String-java.lang.String-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createUserWithoutAttributes</h4>
<pre>public&nbsp;java.lang.String&nbsp;createUserWithoutAttributes(@RequestParam(value="username")
                                                    java.lang.String&nbsp;username,
                                                    @RequestParam(value="email")
                                                    java.lang.String&nbsp;email,
                                                    @RequestParam(value="password")
                                                    java.lang.String&nbsp;password)</pre>
<div class="block">Creates a new user in the system</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>username</code> - The new user's username</dd>
<dd><code>email</code> - The new user's email</dd>
<dd><code>password</code> - The new user's password</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new user</dd>
</dl>
</li>
</ul>
</li>
</ul>
&#13;
&#13;
&#13;

我不知道从哪里开始挖掘这个,所以我感激任何意见。

javadoc -J-version说:

java version "1.8.0_40"
Java(TM) SE Runtime Environment (build 1.8.0_40-b26)
Java HotSpot(TM) 64-Bit Server VM (build 25.40-b25, mixed mode)

Javadoc命令:

javadoc -d docs -Xdoclint:none -sourcepath ./MyProject/src -subpackages com -classpath ./spring-web-4.0.8.RELEASE.jar./spring-context-4.0.8.RELEASE.jar

1 个答案:

答案 0 :(得分:0)

我认为您的问题已通过以下JDK错误得到解决:https://bugs.openjdk.java.net/browse/JDK-8062647

由于上述错误是在Java 9中解决的,因此将项目升级到Java 9应该可以解决您的问题。