2009-07-03 13 views
2

CLRとJavaのようなさまざまな 'クライアント'環境で基本的に同じ機能を提供する一連の関連コンポーネントがあります。現在、Sandcastleを使用してCLRコンポーネントを作成しています.Javaを開始しようとしています。私は、すべてのコンポーネント(CLR/Javaなど)に渡って一貫したルック・アンド・フィールで、統一されたドキュメントを生成し続けたいと考えています。ドキュメンテーションはサイトでのみ利用できるので、私はhtml形式、CHMやその他の形式については気にしません。C#プロジェクトとJavaプロジェクトのSandcastle統一されたドキュメント生成

これは可能ですか? Sandcastleがすべてのドキュメントをすべてのプラットフォームで生成できるようにするために、Sandcastleが使用するスキーマを使用してJavaドキュメントをXMLに集めることができれば、これは可能です。このプロセスは(何らかの形で)ここに記述されています:http://sandcastle.codeplex.com/Thread/View.aspx?ThreadId=32301

もっと単純で単純な代替方法がありますか?

答えて

2

質問を正しく理解していれば、.NETとJavaの両方のドキュメントに統一された外観と感じがあります。あなたがしようとしているオプションは、Sandcastle Builderを使って、あなたがJavaで持っているドキュメントからHTML文書を生成することです。

サンドキャッスルは、サンドキャッスルが期待しているXML形式に出力されても、サンドキャッスルがJavaに存在する型を見つけるのが偶然であるため、これは間違ったアプローチかもしれないと思います。

私のアプローチは、.NETドキュメント/ Sandcastle/MSDNスタイルのドキュメントのスタイルに合わせて、Javaドキュメントのdocletを記述することです。デフォルトのJavadoc HTMLスタイルは珍しいですが、デフォルトの.NET MSDNスタイルのドキュメントは私の見解でははるかに優れているため、それらを照合するのが最良の方法です。

すでにdocletsの富があります。私はXMLを作るためのものを見つけることができませんでした(リンクはdoclet.comサイトで間違っています)。 IBMツールはhereですが、ドックレットを使用しているかどうかはわかりません。

XMLを取得したら、Sandcastle Builderが使用するXSLを同じ見た目のHTMLを作成するように変更できます。

希望があれば+私は正しい行にあります。

更新

誰かがMSDNのドキュメントを生成するドックレットきたように見える:ndoclet、あなたはXSL変換プロセスを省略できることを意味。

1

私は自分のプロジェクトでSandcastleを試しましたが、遅くなる方法でした。

今はJavaをサポートするdoc-o-maticを使用しています。 https://code.google.com/p/sandcastle-presentation/から

+3

また、無料のaletrnativeとしてdoxygen - http://www.stack.nl/~dimitri/doxygen/ - javaと.NETもサポートしています。 –

0

SandcastleDocletはサンドキャッスルのためのXMLファイルを生成することができますドックレットのように見えます。

関連する問題