Javadoc中的Escape @ Character

我知道以前已经有人问过这个问题,但是那里的答案仅适用于较早的JVM.我在8岁.我有一个像这样的javadoc:

 * <pre>
 * {@code
 * 
 * import javax.ws.rs.Path;
 * 
 * import com.ziath.handheldserver.scripts.AbstractHandheldScript;
 * import com.ziath.handheldserver.scripts.valueobjects.ScriptStatus;
 * import com.ziath.handheldserver.scripts.valueobjects.WidgetList;
 * 
 * import org.slf4j.Logger;
 * import org.slf4j.LoggerFactory;
 * 
 * @Path("myBasicScript")

我需要转义’@’符号;我尝试了以下方法:

>用html表示形式替换@,以便@Override变为@Override.这只是在jdocs中打印@Override
>将@Override替换为{@literal @} Override.现在,这将在javadocs中显示{@literal @}替代.
>将@Override替换为@literal @Override;这不会转义@符号,并且javadocs停止解析.

有谁知道如何用JDK 8做到这一点?我为它有多困难感到惊讶!

解决方法:

我在JDK中寻找了带有@符号的代码示例. @SafeVarargs批注具有该功能.它的source code不使用< code>块,但< blockquote< pre>代替.

/**
 * <blockquote><pre>
 * import javax.ws.rs.Path;
 * 
 * import com.ziath.handheldserver.scripts.AbstractHandheldScript;
 * import com.ziath.handheldserver.scripts.valueobjects.ScriptStatus;
 * import com.ziath.handheldserver.scripts.valueobjects.WidgetList;
 * 
 * import org.slf4j.Logger;
 * import org.slf4j.LoggerFactory;
 * 
 * &#064;Path("myBasicScript")
 * </pre></blockquote>
 */

这对我在Java 8上有效,并且看起来还不错.我同意不使用@code有点奇怪.

上一篇:OSGi版本注释的怪异Javadoc错误(带有jdk12)


下一篇:idea 自动生产 api文档