忽略特定屬性

在Visual Studio中，是否有一種方法來裝飾特定的屬性，以將它們從C＃項目生成的默認xml文檔中排除？忽略特定屬性

看看下面的例子：

/// <summary> 
/// This enables the external interface 
/// </summary> 
public string EnableExternalInferface { get; set; } 

/// <summary> 
/// This should not be publicly visible 
/// </summary> 
public bool SecretFeatureSwitch { get; set; }

理想的方法是用一些屬性來裝飾它。

經過額外的研究，我發現了以下問題，Hiding Classes/Methods From XML Documentation。如果這在過去的一年中取得了進展，那將是非常好的，但我並不抱希望。

來源

2013-04-16 Ryan Gates

首先，您爲什麼要省略公共方法/屬性的XML文檔？其次，爲什麼不使用常規評論而不是XML評論？ –

@JustinNiessner出於我無法真正瞭解的原因，這是數據庫配置的工作方式，因此需要公開許多這樣的數據庫，但不能公開，例如客戶/支持/等。常規的非xml註釋將是一個可供選擇的選項，但其中一個缺點是缺少代碼中屬性的智能感知。 –

假設你有一個屬性說

public string val { get; set; }

啓用的XML文件，你會看到下面的警告

「爲公開可見的類型或成員缺少XML註釋」

右鍵單擊錯誤列表中的警告，然後選擇顯示錯誤幫助。它顯示的信息的網頁「編譯器警告（等級4）CS 」上面的C＃預處理器指令#pragma warning圍繞要如下圖所示，從文檔省略屬性一起獲得

使用警告編號。

#pragma warning disable 1591 
public string val { get; set; } 
#pragma warning restore 1591

來源

2013-04-16 20:26:37

這是一個好點，但我仍然可能需要一些文件的財產。 –

忽略特定屬性

回答

相關問題