22

一緒に文書化しようとしているいくつかの内部ライブラリコンポーネントとともに、いくつかのC＃プロジェクトがあります。Sandcastleは、C＃からドキュメントを生成するために行く場所のようです。DocProjectとSandcastleHelpFile Builder GUIのどちらが優れていて、必要な機能をサポートしているのか知りたいです。

各プロジェクトだけをコンパイルしてドキュメントの一部を作成し、最終的にすべてを統合したいと思います。（つまり、1つのドキュメンテーションプロジェクトのライブラリコンポーネントとそれ自体のドキュメンテーションプロジェクトの各プロジェクト、そしてヘルプ2ビューアを使用した単一のルートでの上記のすべて）

4

4 に答える 4

19

Sandcastle Help File Builder を保証できます。これは非常にうまく機能し、Sandcastle Help File Builder プロジェクト内で任意の数のアセンブリを文書化できます。理論的には、Builder プロジェクトを作成し、各 C# プロジェクトのドキュメントを生成してから、すべてを文書化するマスター Builder プロジェクトを作成することができます。

于 2008-12-03T01:42:11.080 に答える
8

Sandcastle ベースの .NET ドキュメントへの便利なリンクを次に示します。

サンドキャッスルのチュートリアル

SHFBの Sandcastle ヘルプ ファイル ビルダー(SHFB)
チュートリアル

Web Project Documentation Web プロジェクト
の文書化方法に関するチュートリアル(より多くのマニュアルと、以前のリンクを考えると古くなっていると思います)

XML ドキュメントの MSDN リファレンス

于 2008-12-29T16:35:27.137 に答える
3

DocProject は使用していませんが、Sandcastle に匹敵する機能を備えた製品のようです。

私はSandcastleを使用しており、効果的なツールであることがわかりました。他の人がここで言及しているように、優れたフロントエンドを提供するには、 Sandcastle Help File Builder (SHFB)も必要です。さらに、 Sandcastle エンジンへのプレゼンテーション層のパッチには、Sandcastle スタイルが必要です。これら 3 つのコンポーネントはすべて 2010 年半ばに新しいリリースがありましたが、Firefox 3.6 のレンダリングの欠陥 (この欠陥レポートの 2010.09.06 エントリに記載されています) のため、2008 リリースからのアップグレードを延期しています。

私はプラットフォームでの私の経験を徹底的に文書化し、その問題と、整頓された専門的なドキュメントセットを作成するために必要な、または考慮したいその他のさまざまな問題について説明しました. 私の記事「サンドキャッスルを使いこなす: コードを文書化するための .NET プログラマー向けガイド」は、2010 年 9 月にSimple-Talk.comで公開されたばかりです。時間、労力、苦痛を節約できるかもしれません:-)。

于 2010-09-14T23:06:03.147 に答える
1

Doc Project は、より洗練されたドキュメントを作成します (機能する場合)。これは常にではありません。それははるかにフレークな製品です。

サンドキャッスル ヘルプ ファイル ビルダは堅実で、仕事を成し遂げます。

于 2009-05-19T15:01:20.287 に答える