文檔評論（子類）

是否有更新文檔的標準方法註釋反映子類的名稱而不是基類？另外，如果方法確實存在，這是我應該練習還是避免的？文檔評論（子類）

實施例：

class BaseClass 
{ 
    /// <summary> 
    /// Gets or sets a value associated with the name of the BaseClass 
    /// </summary> 
    protected string Name { get; set; } 
} 

class SubClass : BaseClass 
{ 
    /// Gets or sets a value associated with the name of the Subclass <-- updated 
    /// protected string Name { get; set; } <-- defined on BaseClass 
}

來源

2011-11-30 Bradford Fisher

號的文檔僅適用於實現的代碼 - 如果你的類繼承從它的基類的方法，則該文檔也繼承。如果沒有提供新的實現，則不能「覆蓋」文檔。（這是有道理的 - 如果實現沒有改變，那麼文檔也不需要改變。）

如果您在外部表單或智能感知中瀏覽文檔，則基類中的文檔將會根據需要顯示，因此無需重新定義它們以查看相應的文檔。

來源

2011-12-03 17:33:05

如果使用Sandcastle Help File Builder，則可以通過使用<inheritdoc/> tag來實現一定程度的重複使用說明。例如，您可以在您的基類上設置摘要，並在您的派生類上使用<inheritdoc/>來獲取相同的內容。但是，我認爲沒有辦法可以動態地改變它（例如替換類名）–您可以繼承整個摘要文本，也可以不繼承。

來源

2011-12-03 19:41:27

文檔評論（子類）

回答

相關問題