程序员最近都爱上了这个网站  程序员们快来瞅瞅吧!  it98k网:it98k.com

本站消息

站长简介/公众号

  出租广告位,需要合作请联系站长


+关注
已关注

分类  

暂无分类

标签  

暂无标签

日期归档  

暂无数据

将方法参数与 JavaDoc 中的类成员链接

发布于2023-03-13 23:35     阅读(1138)     评论(0)     点赞(9)     收藏(0)


在我们公司,有一项严格的规定,即必须对所有内容进行评论。该规则有一些弱点,例如重复文本。为了避免重复注释,我想将方法​​参数引用到类成员,但找不到合适的解决方案。

当我在方法参数中链接类成员并将方法参数悬停时,

  /**
   * I would like to see this comment
   */
  private int       lineNumber;

  /**
   * Creates a new {@link GroupByMetaData} object.
   *
   * @param aLineNumber {@link GroupByMetaData#lineNumber}
   */
  public GroupByMetaData( int aLineNumber )
  {
    super();
    this.lineNumber = aLineNumber;
  }

以下结果是;

在此处输入图像描述

实现这一目标的正确方法是什么?


解决方案


无法将一个项目的 javadoc 复制到另一个项目中,除非{@inheritDoc}只能从同一项目的超类文档中插入。

构造函数设置私有 int 字段的事实是内部实现的一部分。您的 javadoc 不应提及或{@link}提及私有字段;相反,javadoc 应该从概念上描述它。

私有 javadoc 通常与公共 javadoc 不同。私有 javadoc 将包含该类的一般用户不应看到的重要实现细节。例如:

/**
 * Line of input this object will analyze.  This is never negative.
 * Controls the loops in the `read` method and the `translate` method.
 */
private int lineNumber;


所属网站分类: 技术文章 > 问答

作者:黑洞官方问答小能手

链接:http://www.javaheidong.com/blog/article/650248/09e4a0e38d1466a73cc2/

来源:java黑洞网

任何形式的转载都请注明出处,如有侵权 一经发现 必将追究其法律责任

9 0
收藏该文
已收藏

评论内容:(最多支持255个字符)