Sandcastle針對C＃和Java項目的統一文檔生成

Question

我有一組相關組件，它們基本上爲各種「客戶端」環境（如CLR和Java）提供相同的功能。目前，我正在使用Sandcastle爲CLR組件生成我的文檔，並且我即將開始使用Java。我想繼續生成一個統一的文檔，並且在所有組件（CLR/Java以及後續的任何組件）中具有一致的外觀和感覺。該文檔將只在網站上提供，所以我只關心html格式，不使用CHM或其他格式。

這可能嗎？正如我所看到的，如果我可以將Java文檔收集到Sandcastle所用模式的XML文件中，以便讓Sandcastle爲所有平臺生成所有文檔，那麼這將是可能的。這個過程（不知何故）在這裏描述：http://sandcastle.codeplex.com/Thread/View.aspx?ThreadId=32301

是否有一些更直接，更簡單，替代？

Answer 1

如果我正確地理解了這個問題，您希望.NET和Java文檔具有統一的外觀和感覺。您要使用的選項是使用Sandcastle Builder從您在Java中擁有的文檔生成HTML文檔。

我認爲這可能是錯誤的方法，因爲Sandcastle會蹣跚發現Java中存在的類型，即使它被輸出爲Sandcastle期望的XML格式。

我的方法是爲您的Java文檔編寫doclet，以匹配.NET/Sandcastle/MSDN樣式文檔的樣式。默認的Javadoc HTML風格是可怕的，默認的.NET MSDN風格文檔在我看來非常優越，所以匹配這些將是最好的方法。

已經寫入了豐富的doclets。我無法找到生成XML的鏈接（doclet.com網站上的鏈接不正確）。一個IBM工具通過here來完成，不管它使用的是我不確定的doclet。

一旦擁有了XML，就可以調整Sandcastle構建器用來生成相同外觀HTML的XSL。

希望這可以幫助+我在正確的路線。

更新

看樣子有人作出了doclet生成MSDN文檔：ndoclet，這意味着你可以跳過XSL轉換過程。

Answer 2

我爲我的項目嘗試過Sandcastle，但它是減速的方式。

現在我使用doc-o-matic，它也支持Java。

Answer 3

的SandcastleDoclet從 https://code.google.com/p/sandcastle-presentation/樣子，可以生成沙堡XML文件的doclet。