Visual Studio 2010中的應用程序設置文檔（XML）

我最近使用Visual Studio（2010）創建了一個（C＃）項目，並使用了一些設置（我在屬性下創建）。Visual Studio 2010中的應用程序設置文檔（XML）

我發現可以在我的文檔中添加一些XML註釋的唯一地方是Settings.Designer.cs。但是這個文件是自動生成的，所以每當我改變設置時，註釋都不見了。

即使Visual Studio中給出開始給mewarnings，「缺少XML註釋進行宣傳明顯類型或成員......」

我的問題這裏：什麼是XML註釋添加到我的設置最巧妙的方法？

有沒有比Settings.Designer.cs更好的地方？
我應該停止自動生成文件嗎？怎麼樣？
還有其他方法嗎？

我使用的沙堡幫助文件生成器的方式

來源

2010-05-11 SirLenz0rlot

如果您打開您的設置（使用默認設計器），您可以在屬性窗口中找到屬性「描述」。填充它，它將用作自動生成文件中的XML註釋摘要。

來源

2010-09-22 06:50:32 veselka

我無法檢查出來，但謝謝。這個問題發佈了很長時間，但將來會嘗試。謝謝 – SirLenz0rlot 2010-09-22 11:52:31

我也無法找到它。但我認爲你所說的是「資源」，這與設置不同。 – Gqqnbig 2012-08-08 01:01:17

只是想指出，您必須選擇有問題的設置才能從屬性窗口編輯其描述。 – 2014-07-14 08:08:42

做到了。我仍然不確定是否有更好的方法，但我添加了SettingsDoc.xml到我的Sandcastle HFB項目。的缺點是它不會被visual studio編譯，所以我需要更新和檢查引用等我自己。

來源

2010-05-25 12:59:54 SirLenz0rlot

在你的Settings.settings文件中（不要用設計器打開它），添加一個屬性，例如：「說明」：

<Setting Name="MySetting" Description="This property does blah blah blah" Type="System.Int32" Scope="Application"> 
    <Value Profile="(Default)">42</Value> 
</Setting>

這將產生

/// <summary> 
/// This property does blah blah blah 
/// </summary> 
[global...] 
public int MySetting { ...

您也可以建立一個工具，它的Settings.settings文件並創建一個MAML主題文件。在您項目的構建活動中調用該工具，然後調用。

在我的測試中，如果您將描述作爲Setting元素的屬性，那麼如果您在設計器中更改設置，則該屬性將被保留。但是，如果您將其設置爲Setting元素的子元素，它將被刪除。

來源

2012-12-13 20:51:56 laurian

Visual Studio 2010中的應用程序設置文檔（XML）

回答

相關問題