如何转义 javadoc 中的 @ 字符?

2022-08-31 06:11:35

如何在javadoc中转义符号?我试图在标签内使用它,这是在标签里面。@{@code}<pre>

我已经尝试了html转义序列,但这不起作用。&#64;


答案 1

使用 {@literal} javadoc 标签:

/**
 * This is an "at" symbol: {@literal @}
 */

用于此的 javadoc 将如下所示:

This is an "at" symbol: @

当然,这将适用于任何字符,并且是显示任何“特殊”字符的“官方支持”方式。

它也是最直接的 - 你不需要知道字符的十六进制代码你可以阅读你输入的内容!


答案 2

只需将其编写为 HTML 实体:

&#064;

来自文档“javadoc - Java API Documentation Generator”"

如果要以 @ 字符开始一行,并且不对其进行解释,请使用 HTML 实体 @。

这意味着您可以将 HTML 实体用于需要转义的任何字符,并且实际上您可以:

文本必须使用 HTML 实体和 HTML 标记以 HTML 格式编写。您可以使用浏览器支持的任何版本的 HTML。标准 doclet 在其他地方(文档注释之外)生成符合 HTML 3.2 的代码,并包含级联样式表和框架。HTML 4.0 是生成的文件的首选,因为框架集。

例如,小于符号 (<) 和大于符号 (>) 的实体应写为 和 。同样,与号 (&) 应写为 。&lt;&gt;&amp;