Java通过类中的私有变量进行docstringes

时间:2010-07-02 13:04:02

标签: java eclipse docstring

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

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

1 个答案:

答案 0 :(得分: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;
...

希望有所帮助,但问题仍然存在:如果有公共吸气剂,你为什么要公开实施?