在JavaDoc中将方法参数与类成员链接
在我们公司,有一条严格的规定,每件事都要发表评论。这条规则有一些缺点,例如重复文本。为了避免重复注释,我想将方法参数引用到类成员,但找不到合适的解决方案 当我在方法参数中链接类成员并悬停方法参数时在JavaDoc中将方法参数与类成员链接,java,javadoc,Java,Javadoc,在我们公司,有一条严格的规定,每件事都要发表评论。这条规则有一些缺点,例如重复文本。为了避免重复注释,我想将方法参数引用到类成员,但找不到合适的解决方案 当我在方法参数中链接类成员并悬停方法参数时 /** * I would like to see this comment */ private int lineNumber; /** * Creates a new {@link GroupByMetaData} object. * * @
/**
* 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;
}
结果如下:
实现这一目标的正确途径是什么 除了只能从同一项的超类文档插入的
{@inheritDoc}
之外,无法将一项的javadoc复制到另一项
构造函数设置私有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;
@请参见
可能???@RC。我读过一些文章,其中最重要的是,据说see标记应该用来链接其他密切相关的类,这些类的Javadocs可以让读者更清楚地了解类的用途。如果lineNumber字段是public字段而不是private字段,有没有办法链接它?恐怕没有。只有{@inheritardoc}
。非常感谢您的回答。有时,知道这是不可能的也是有益的:)