Java 文档字符串通过类中的私有(private)变量

Question

public static class cls{
    private String text;
    public String getText(){
        return text;
    }
}

是否可以在 Java 中的 cls 文档字符串中显示 text 变量，而无需复制粘贴内容？

Answer 1

我不确定你想做什么。您可以使用以下两种方式之一从 JavaDoc 链接到该变量:

/**
 * The cls class
 * see {@link cls#text} or
 * @see cls#text
 */
public static class cls {
    private String text;
...

然后您可以将 JavaDoc 附加到该变量并在那里描述您需要说的内容。据我所知，除了复制和粘贴之外，没有其他方法可以在 JavaDoc 中显示一行代码。但如果您愿意，您可以使用 HTML 改进格式:

/**
 * The cls class, see this field:
 * <code>private String text;</code>
 */
public static class cls {
    private String text;
...

希望有所帮助，但问题仍然存在:如果有公共(public) getter，为什么要公开实现？