2008年11月10日 星期一

產生漂亮的 .NET Class 文件

在 Java 中有 JavaDoc 可以協助製作 class 說明文件,那在 .NET 中,當然首推擁有 GUI 介面,並可與 Visual Studio .NET 2005/2008 整合的 DocProject 來製作文件囉!

詳細的安裝與使用說明已經有人寫過囉!

可以參考以下這幾篇文章:
  1. 使用DocProject外速產生.NET物件文件(一)

  2. 小豪的隨想手札 - Visual Studio 2008注解文件的方案

假設要針對 myProject 這個專案產生文件的話,要注意的有兩點:
  1. 在專案的屬性設定中勾選輸出 XML 文件檔案
  2. 從「myProject 專案內」再新增一個 DocProject 專案 (不是在外面重新建一個 DocProject 專案喔!)

如此一來 DocProject 就可以自動產生漂亮的文件囉! 想當然爾........註解也是要寫清楚啦! 不然怎麼會有漂亮的文件可以看呢........

當然裡面還有很多細部設定,想要瞭解的人可以去參考官方網站 的說明囉!

沒有留言:

張貼留言