2013/07/02

.Net 產生函式庫說明檔

最近在寫關於HRV的DLL,平常寫程式都只有寫上註解
但封裝成DLL的時候,就沒有註解可以看了,但可以使用Visual Studio的物件瀏覽器去瀏覽DLL有包裝什麼方法在裡面,效果又是如何?



不知道有什麼Tag可以使用的人可以參考『建議的標記,文件註解 (Visual C++)』,這篇寫得還蠻詳細
雖然是For C++,仍是值得參考呀!




那要如何讓自己寫得dll有函式庫帶有說明檔呢?可以參考一下『/doc (處理文件註解) (C/C++)

今天將使用VS2012來作示範,目前有寫好一個HRV的DLL,拿其中一段來舉例吧

我有一個方法叫做Stop,該方法我希望能夠在物件瀏覽器裡面看到該方法是『停止HRV資料傳送』
static void Stop(){

只要在該方法名稱上面加上
/// <summary>停止HRV資料傳送</summary>


範例如下:
/// <summary>停止HRV資料傳送</summary>
static void Stop(){


並且點選該專案屬性


點選『所有組態』,C/C++的輸出檔,將『產生XML文件檔』選取為是/doc



在將該專案重新建立,就可以在物件瀏覽器看到Stop方法為『停止HRV資料傳送』




參考資料:
http://msdn.microsoft.com/zh-tw/library/ms177227.aspx
http://msdn.microsoft.com/zh-tw/library/ms173501.aspx