如何在 Javadoc 中编写标签

Question

我想在 javadoc 中评论示例标记语法。但是 Javadoc 不会在其注释中显示标签。可以这样做吗？

示例：未显示 svg 标签注释，因为 javadoc 将标签解释为非注释。

/**
 * 
 * @param sMapData contains tags like the following sample : <br>
 * <svg><text color="000000" dates="-626,100;-545,100" fontsize="8" fs="normal" id="text31757_i1a" opa="1" text="L y d i a n" x="2915.5793" y="1889.9111"/></svg>
 * @return
 */

Answer 1

根据 this answer 至 Javadoc 注释中的多行代码示例，您可以使用 {@code } 包装在 <pre></pre> 中：

/**
 * 
 * @param sMapData contains tags like the following sample:
 * 
 * <pre>
 * {@code
 * <svg>
 *   <text color="000000" dates="-626,100;-545,100" fontsize="8" fs="normal" id="text31757_i1a" opa="1" text="L y d i a n" x="2915.5793" y="1889.9111"/>
 * </svg>
 * }
 * </pre>
 * @return
 */

如何在 Javadoc 中编写标签

How to write tags in a Javadoc

java

javadoc