iT邦幫忙

DAY 5
1

在錯誤中學習ASP.NET MVC系列 第 5

認識VS開發環境 - 註解與程式碼說明文件

在介紹如何撰寫程式之前,最最重要的就是如何為程式加上註解

註解

  1. 多行註解:/* 我是註解 */

  2. 單行註解://我是註解

  3. 工作清單://可以搭配TODO或是HACK來做為工作清單使用
    例如在程式碼內加上以下註解:

    // TODO:撰寫例外處理的程式(例如發 Mail 通知系統管理者)

​就可以在工作清單視窗中看到工作項目,並且點兩下會導到撰寫註解的地方,覺得這是個很貼心的功能阿,就像便利貼一樣,可以提醒自己那些地方需要修改或注意的。

另外如果覺得TODO或是HACK不夠用也可以自己宣告,請到「工具>選項>環境>工作清單」設定

程式碼說明文件

在Java裡面大概聽過JavaDoc,通常在專案結束的時候才會需要用到,因為可能要開始產生一些根本不太會有人去看的程式碼說明書了,在VS裡面也有類似的功能,不過在產生說明之前得先在程式碼裡面將註解寫好才有辦法產生對應的說明。

撰寫的方式就是在類別、方法的上一行**///**就會自動產生文件註解標籤的格式,然後再自行將註解補上:

在Eclipse是打/**+Enter,比較不同的是VS裡面是使用XML的方式來定義文件註解標籤,想查詢更多的文件註解tag可以參考這邊

接下來就是如何產生說明文件了,請參考以下步驟:

1.安裝[Sandcastle Help File Builder](http://shfb.codeplex.com/" style="line-height: 1.6;)

2.產生專案xml,對著專案按右鍵>屬性>建立>打勾XML文件檔案

  1. 開啟Sandcastle Help File Builder GUI >左上角> File>New Project

  2. 加入dll與xml ,對著右欄的Documentation Sources按右鍵 > Add Documentation Source... >Documentation > Build Porject

  3. 開啟Sandcastle 產生的Help資料夾,下圖為開啟index.htm的畫面


上一篇
認識VS開發環境 - 快速鍵
下一篇
認識VS開發環境 - 擴充功能
系列文
在錯誤中學習ASP.NET MVC30

尚未有邦友留言

立即登入留言