【问题标题】:How to block comment or tags in document comment using Javadoc如何使用 Javadoc 阻止文档注释中的注释或标签
【发布时间】:2020-02-06 17:10:50
【问题描述】:

如何阻止 img 标记或 Java 文档中的任何行。当我将光标放在课堂上时,它会显示多次。对于功能参考,我在文档注释(文档注释)中使用了两个 img 标签。谁能告诉我如何通过阻止<img src="../../../../resources/images/java-basic-ASCII Table.png" /> 行来只显示一个img 标签。

package com.java.escapesequence;

/**
 * 
 * @author udaykiranp
 * 
 * </br>
 *  <img src="../../../../resources/images/java-basic-ASCII Table.png" />
 * 
 *  <img src="{@docRoot}/../resources/images/java-basic-ASCII Table.png" />
 */
public class CharSequence {
    public static void main(String[] args) {
        System.out.println((char) 33);
        System.out.println((char)0x2B);//hexa decimal start with 0x
        System.out.println((char)056);//octa decimal start with 0
    }
}

将光标放在类上时的图像:

【问题讨论】:

  • 我认为这不可能。但是到底为什么你有两个img 标签呢?
  • 删除线?
  • 也完全不相关:有一个名为 CharSequence 的类并不好。
  • @Seelenvirtuose 仅​​供参考,我提到了两个 img 标签。
  • 把它作为一个see-also链接。不要强迫 Javadoc 的每个读者都面对图像。那里和这里一样糟糕。

标签: java html image annotations javadoc


【解决方案1】:

如果我们想使用两个标签并且需要在 javadoc 中阻止其他标签/注释以获取功能引用,我们需要使用 See Also 使用 @see 链接。

package com.java.escapesequence;

/**
 * 
 * @author udaykiranp
 * 
 * </br>
 *
 *  <img src="{@docRoot}/../resources/images/java-basic-ASCII Table.png" />
 *  @see <a href="../../../../resources/images/java-basic-ASCII Table.png">java-basic-ASCII Table.png</a>
 */
public class CharSequence {
    public static void main(String[] args) {
        System.out.println((char) 33);
        System.out.println((char)0x2B);//hexa decimal start with 0x
        System.out.println((char)056);//octa decimal start with 0
    }
}

Java 文档:

【讨论】:

    猜你喜欢
    • 2014-11-30
    • 2015-11-02
    • 2023-03-12
    • 2015-02-15
    • 1970-01-01
    • 1970-01-01
    • 2011-08-02
    • 2017-02-28
    • 1970-01-01
    相关资源
    最近更新 更多