java - 如何在我的 javadoc 示例中编写 block 注释？

标签 java javadoc

<分区>

所以我有一个看起来像这样的 javadoc(当然对公众进行了审查):

/**
 * Description of my method
 * <p>
 * <b>Example:</b>
 * </p>
 * <pre>
 * {@code
 * /**
 *  * Sample Javadoc
 *  *&#47;
 *  public final void testMyMethod()
 *  &#123;
 *      // some logic
 * &#125;}
 * </pre>
 * @return Description of my return value.
 */

所以这样做的原因是在我的示例中执行 */将结束 javadoc。使用大括号会混淆 @code 标记。

问题是生成的 javadoc 显示的是 HTML 实体代码，而不是我想向 javadoc 的使用者显示的实际字符。关于如何解决这个问题的任何想法？

最佳答案

不幸的是，没有真正的方法可以做到这一点(至少我不知道。)我过去一直被这个问题困扰，这真的很烦人!

获得正确方法的两种解决方法(都不是很好)是:

  • 关闭并重新打开代码标签以排除烦人的字符(这样做 }&#47;{@code )

  • 开沟 {@code完全使用老式的<code>标签。

就我个人而言，我更喜欢最后一种方法，因为它更简洁，而且(大概)更容易在修复出现时更容易转换 - 但它并不理想。

关于java - 如何在我的 javadoc 示例中编写 block 注释？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/22102702/

上一篇：java - 如何使用基于 Java 的配置来配置 Spring Batch StepScope？

下一篇：java - IntelliJ IDEA 中的 Gradle Java 调试项目

相关文章：

java - 使用 Java 8 查找两个日期之间的中间日期

java - Doclet 与 DocLava

Javadoc 排除导致导入错误

c# - 如何从 javadoc 中排除某些类/包/公共(public)成员

android - Eclipse Android 项目中的 JavaDoc

java - HikariPool-1 - 无法执行连接的 isValid()，配置连接测试查询 (oracle.jdbc.driver.T4CConnection.isValid(I)Z)

java - ICEFaces inputFile 获取文件内容而不上传

java - 尽管我的类(class)已加载，但 Class.forName 会抛出 ClassNotFoundException

java - 方法内部不允许接口(interface)

javadoc - 如何在 gitlab 中发布 javadoc？

©2024 IT工具网  联系我们