在Javadoc逃脱@角色

时间:2017-12-10 12:47:21

标签: java java-8 javadoc

我知道之前已经问过这个问题,但那里的答案只适用于较旧的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")

我需要逃避&#39; @&#39;符号;我尝试过以下方法:

  • 用html表示替换@,因此@Override变为@Override。这只是在jdocs中打印@Override
  • 将@Override替换为{@literal @}替换。现在,这将在javadocs中打印{@literal @}覆盖。
  • 用@literal @Override替换@Override;这并没有逃避@符号,javadocs停止解析。

    有没有人知道如何使用JDK 8?我很惊讶它有多难!

3 个答案:

答案 0 :(得分:2)

我在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有点奇怪。

答案 1 :(得分:1)

您可以使用 new webpack.optimize.CommonsChunkPlugin({ name: 'client', async: 'common', children: true, minChunks: (module, count) => { if (module.resource && (/^.*\.(css|scss)$/).test(module.resource)) { return false; } return count >= 3 && module.context && !module.context.includes('node_modules'); }, }), new webpack.optimize.CommonsChunkPlugin({ name: 'client', children: true, minChunks: module => module.context && module.context.includes('node_modules'), }), new webpack.optimize.CommonsChunkPlugin({ name: 'vendors', minChunks: module => module.context && module.context.includes('node_modules'), }), 来完成此操作,以便在文本中出现{@literal @}个字符。另外,如果您想在JavaDoc中包含代码块并希望转义所有 @字符,我建议将@块与{{1}结合使用像这样:

<pre>

答案 2 :(得分:0)

您可以使用{@code}。这是* <pre> * {@code * ... my code here... * } * </pre> 的示例,但您可以将{@literal @}用于任何特殊字符