如何插入VS XML注釋代碼
本文主要講述VS XML注釋，怎樣是源代碼插入VS XML注釋，如何把VS XML注釋輸出為有用文檔，這些內(nèi)容都是一些門戶網(wǎng)站和技術(shù)論壇找到的，歡迎大家學(xué)習(xí)切磋交流。。
C# 允許開發(fā)人員在源代碼中插入VS XML注釋，這在多人協(xié)作開發(fā)的時候顯得特別有用。 C#解析器可以把代碼文件中的這些XML標記提取出來，并作進一步的處理為外部文檔。 這篇文章將展示如何使用這些VS XML注釋。作者演示了如何生成工程，如何把VS XML注釋輸出為有用文檔，如何把這些注釋轉(zhuǎn)變?yōu)閹椭募?在項目開發(fā)中，很多人并不樂意寫繁雜的文檔。
但是，開發(fā)組長希望代碼注釋盡可能詳細；項目規(guī)劃人員希望代碼設(shè)計文檔盡可能詳盡；測試、檢查人員希望功能說明書盡可能詳細等等。 如果這些文檔都被要求寫的話，保持它們同步比進行一個戰(zhàn)役還痛苦。 #t#
為何不把這些信息保存在一個地方呢？？最明顯想到的地方就是代碼的注釋中；但是你很難通覽程序，并且有些需要這些文檔的人并不懂編碼。
這篇文章將展示如何通過使用VS XML注釋來解決這些問題。代碼注釋、用戶手冊、開發(fā)人員手冊、測試計劃等很多文檔可以很方便的從VS XML注釋中獲得。我將先演示如何插入XML注釋、如何把這些XML注釋導(dǎo)出為另一個文檔。然后再討論每個XML標記的意思，以及使用XML和XSL生成幫助文件。
所有的XML注釋都在三個向前的斜線之后(///)。兩條斜線表示是一個注釋，編譯器將忽略后面的內(nèi)容。三條斜線告訴編譯器，后面是VS XML注釋，需要適當?shù)靥幚怼?/P>
當開發(fā)人員輸入三個向前的斜線后，Microsoft Visual Studio .NET IDE 自動檢查它是否在類或者類成員的定義的前面。如果是的話，Visual Studio .NET IDE 將自動插入注釋標記，開發(fā)人員只需要增加些額外的標記和值。下面就是在成員函數(shù)前增加三個斜線，自動增加的注釋。代碼如下：
- /// <summary>
- ///
- /// </summary>
- /// <param name="strFilePath"></param>
- public void LoadXMLFromFile(string strFilePath)
