代码之家  ›  专栏  ›  技术社区  ›  Christian

Java在类中通过私有变量进行文档查询

  •  0
  • Christian  · 技术社区  · 14 年前
    public static class cls{
        private String text;
        public String getText(){
            return text;
        }
    }
    

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

    1 回复  |  直到 13 年前
        1
  •  1
  •   Stephan    13 年前

    我不知道你想干什么。您可以通过以下两种方式从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;
    ...
    

    希望这有帮助,但问题仍然存在:如果有公共getter,为什么要公开实现?