將方法參數與JavaDoc中的類成員鏈接

在我們公司中，有一條嚴格規則，即必須評論所有內容。這條規則有一些薄弱點，例如重複的文本。爲了避免重複的評論，我想引用一個類成員的方法參數，但找不到合適的解決方案。將方法參數與JavaDoc中的類成員鏈接

當我在方法參數類成員鏈接和懸停的方法參數，

/** 
    * 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; 
    }

下面的結果是;

什麼是實現這一目標的正確方法？

來源

2017-07-10 drJava

'@ see' maybe ??? –

@RC。我已經閱讀了一些文章，主要是，據說應該使用標籤來鏈接其他密切相關的類，Javadocs會讓讀者更清楚地瞭解該課程的目的。 – drJava

沒有辦法將一個項目的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;

來源

2017-07-10 14:11:31 VGR

如果lineNumber字段是公共字段而不是私人的，有什麼辦法可以鏈接它嗎？ – drJava

恐怕不是。只有'{@inheritDoc}'。 – VGR

非常感謝您的回答。有時候，要知道這是不可能的也是有益的:) – drJava

將方法參數與JavaDoc中的類成員鏈接

回答

相關問題