2014-04-07 224 views
1

我有一個包含許多強類型數據集的項目。如何自動生成.designer.cs文件文件?

我需要爲它們添加一些XML註釋,但只是在圖形化數據集編輯器中進行小的更改會導致附加的.designer.cs文件的重新生成會擦除以前編輯的註釋。

除了自動生成的代碼中的註釋具有差的格式:

/// <summary> 
///After opening tag... 
///The text is attached to the slashes, 
///causing doxygen to put the enclosing tag into doc 
///</summary> 

由於所有自動生成的類是部分I加入一個手動編輯的.cs與內部的所有文檔文件。這對於類聲明很有效,但是它們的屬性和方法呢?

任何人都知道更好的策略來記錄強類型的數據集?

回答

-1

Microsoft爲文檔提供內置工具。您可以生成通過以下步驟

文檔生成一個XML文檔文件的Visual Basic項目

  1. 隨着Solution Explorer中選擇一個項目,項目菜單, 單擊屬性上。
  2. 單擊編譯選項卡。
  3. 在編譯頁面上,選擇生成XML文檔文件。默認爲 ,該文件是在指定的輸出路徑下創建的,例如 示例「bin \ Debug \ Projectname.XML」。

要生成一個Visual C#項目

  1. 隨着解決方案管理器中選擇一個項目一個XML文檔文件,在項目菜單上, 單擊屬性。
  2. 單擊生成選項卡。
  3. 在生成頁面上,選擇XML文檔文件。默認情況下, 文件在指定的輸出路徑下創建,例如, 「bin \ Debug \ Projectname.XML」。

我建議你看看GhostDoc。它是新版Visual Studio的一個驚人的插件。 http://submain.com/products/ghostdoc.aspx 它將以智能方式自動生成XML文檔。當然其他人有他們最喜歡的。

+0

GhostDoc似乎是一個很好的專業工具,但是我對Visual Studio 2005感到震驚。除此之外,我知道如何讓Visual Studio生成代碼文檔。我只是想知道如何正確地把代碼文檔放在自動生成的文件中。 – sblandin