一份完整又詳細的物件文件，在團隊溝通、技術傳遞或使用上都有很大的重要性(自用也很不錯)，想想一個新加入團隊或接手你工作的人，沒有文件只有看原始碼或註解去猜功能，這是多什痛苦的一件事，但寫一份物件文件在之前是非常麻煩的，而且完全沒有相輔的工具，像我最早寫物件文件，是用Word做，Class Name、Funciotn、Property等都是用複製貼上，然後加打上說明，費時又費力，而且又沒有同步功能，當纇別修改了也就只有打開來Word修改，之後為了改善這困境，找了不少軟體，像NDoc等，雖然比Word好用很多，但使用上還是很不便，而且無法自訂內容(可能是我不會用)，不過現在有了DocProject作一份物件文件就不是件困難的事(僅使用上)。
DocProject是在CodePlex上的一個專案，CodePlex是學.NET必來的網站，我就是從Visual Studio Addins中找到DocProject，DocProject的使用上非常的簡單，內容編輯與設定都是圖型化，使用上非常的方便，產生的文件就像MSDN Library一樣美觀與方便閱讀，也有索引、查尋功能，實在是太好用了，經曾看過一編文章說所以Sandcastle的工具，讓他們公司原本要花好幾天的時候做文件，現在十分鐘就好了，這不是誇張，如果平實在建物件時就勤於輸入XML文件註解，產生一份完整又詳細的物件文件真的只要十分鐘，DocProject是Visual Studio 2005/2008的增益集，以專案的方式使用，也有應用視窗版，給無法使用增益集的Express使用，目前專案方式只支援C#與VB.NET，C++/CLI只能應用視窗產生(沒試過)。
DocProject 官方網站 內有豐富的說明
安裝DocProject必需需要以下軟體(官方說明)
Visual Studio 2005 with Service Pack 1
Sandcastle, June 2007 CTP
HTML Help Workshop: Help 1.x
Visual Studio 2005 SDK: Help 2.x (可以不裝)
安裝完以上軟體在安裝 DocProject
使用範例 http://www.cnblogs.com/hwade/articles/885020.html
沒有留言:
張貼留言