Sandcastle同NDoc的比較

iDotNetSpace發表於2008-06-26
什麼是Sandcastle?

具體的資訊在這裡可以看到。

在釋出VS2005之前,MS內部開發了一個用於生成幫助文件的工具。這就是Sandcastle的前身。但是當時編譯一次文件就需要十多個鐘頭——好傢伙,真是夠長。當然,後來釋出的Sandcastle由於做了很大的優化,就只要30分鐘了。(看得出來MS內部的開發流程也是十分Agile的,現有成果,然後才作重構和優化的。)

當然,現在的Sandcastle經歷了幾個CTP版本的測試已經比較成熟了。

Sandcastle同NDoc的比較

由於NDoc專案終結了,所以一直沒有機會達到.NET 2.0完全支援的地步。另外,NDoc還是MSDN 2003的風格,同VS2005漂亮的樣式稍有差距。但是下面這些特點是Sandcastle一直缺乏的。

1. JavaDoc,LaTeX的支援。這個也不知道會不會在後期加入。我特別喜歡的就是LaTeX的支援。NDoc生成的LaTeX文件十分的漂亮。

2. 官方的GUI工具。現在我使用的GUI工具還是Sandcastle Help File Builder(SHFB)。MS官方僅僅提供了全部的命令列工具。

3. 將來似乎會被加入到VSSDK裡頭,這樣想僅僅安裝Sandcastle似乎就麻煩了一點。

我的選擇

今年11月之前我一直使用的是NDoc。很顯然,CBC還處於.NET 1.1的平臺上面,NDoc的工作就很好了。但是,面臨著NDoc沒有更新的情況,我遲早也會轉入Sandcastle的上面。促使這一個過程加速的重要原因,就是SHFB了。由於這個介面同NDoc別無二致,隱藏了全部細節,十分方便NDoc的使用者轉到這一新的工具上面。另外,由於該工具還提供十分方便的命令列版本,可以整合到NAnt或者MSBuild指令碼中,所以我還不猶豫的將CBC的文件全部放心的交給了它來處理。

來自 “ ITPUB部落格 ” ,連結:http://blog.itpub.net/12639172/viewspace-366006/,如需轉載,請註明出處,否則將追究法律責任。

相關文章