問題タブ [sandcastle]

Visual Studio XML出力からMSDNスタイルのドキュメントを作成する簡単な方法はありますか？
私はこの橋を渡る最初の人ではないことを知っているので、私はそれのために良いxsltを設定するのに十分な忍耐力がありません。

また、最近サンドキャッスルを設置してみましたが、本当に目が離せませんでした。その過程で重要な何かが欠けていたか、それはあまりにも複雑すぎます。

私はそこにいる誰かが本当に素晴らしい非常に単純な解決策を持っていることを知っています。

私のフォーマットによってその段落が読みたくないものになったと思うので、ここで繰り返します。

サンドキャッスルを試してみましたが、セットアップするのに本当に苦労しました。私が本当に心に留めているのは、もっと単純なことです。

つまり、砂の城のプロセスを理解していない限りです。テスターが作業するのに良いものを作るためだけに、私には非常に多くの余分な荷物のように見えました。

Web サイトの Sandcastle ヘルプ ファイルを生成しようとしています。プロジェクトのプロパティ ウィンドウには、Sandcastle に必要な XML ドキュメント ファイルを作成するためのオプションがありません。

プロパティ ページの [ビルド] タブには、[開始アクション]、[ソリューション アクションのビルド]、および [アクセシビリティ検証] のオプションのみが含まれています。私の他のプロジェクトのように、出力や XML ドキュメント ファイルのオプションはありません。

私が使用している Web サイトには実際の .proj ファイルがありません。これが問題になる可能性があります。これが問題である場合、ソース管理下にあり、混乱を最小限に抑えて多くの人が取り組んでいるプロジェクト用に作成する最良の方法は何ですか?

これは、Visual Studio 2005 プロフェッショナルを使用しています。

職場では、ヘルプ ファイルの作成に Sandcastle を使用しています。しばらくの間 S​​andCastleGUI を使用しており、ヘルプ ファイルに追加のページを作成する方法を探しています。これらのページは、MAML と呼ばれる XML 形式で記述されています。唯一の問題は、これらのファイル形式に適したエディターが見つからなかったことです。

追加のドキュメント ページを作成および編集するための WYSIWYG エディタを探しています。

少し前に、私たちのプロジェクトの 1 つのドキュメント Web サイトを生成するためにSandcastleを使い始めました。非常にうまく機能していますが、私たちは常にプロジェクトのクラス、メソッド、プロパティ (...) のドキュメントのみを作成し、プロジェクト全体とプロジェクトのパーツ/モジュール/名前空間のドキュメントを完全に分離していました。そのドキュメントをまとめて、生成されたヘルパー ファイルにそれぞれのドキュメントを追加できればいいのですが、その方法がわかりません。

名前空間宣言にコメントを追加するだけでは機能しないようです (C#):

誰もこれを行う方法を知っていますか? どういうわけかそれが可能であることを知っています、そしてそれがあれば本当にいいでしょう... :)

Visual Studio のビルド ステップで HTML ドキュメントを自動的にビルドするには、どのような手順を実行する必要がありますか? すべてのコメントが配置され、comments.xml ファイルが生成され、Sandcastle がインストールされました。ドキュメントを生成するために、ビルド後のステップに何を追加すればよいかを知る必要があります。

Delphi コード用の javadoc または c# xml doc に似たコード ドキュメント ツールが必要です。最適なツールは何ですか? 私は、Microsoft のサンドキャッスル プロジェクトと将来的に互換性のあるテクノロジを好みます。

する必要がある

1. Web サイト (HTML) である Sandcastle Help File Builder (SHFB) 出力を Media wiki 形式に変換する
2. 変換されたページを、設定した MediaWiki に直接転送/含める方法を見つけてください。

何か案は？ウェブサイトには 1000 ページ以上の HTML ファイルがあります (SHFB の出力)。

私は html2wiki コンバーターを使用することを考えました..これらの 1000 ページを wiki 形式に変換するスクリプトを探し回ることを考えることができました... (1) を処理できるスクリプトです。

しかし、パイプラインの最後の部分にまだブロックが残っています - 変換されたページを Wiki に直接フィードする方法は?

.NET ソース内のコード ドキュメントの量が多すぎますか?

いくつかの背景: SO に投稿した他の質問のいくつかで話した大きなコードベースを継承しました。このコードベースの「機能」の 1 つは、God クラスです。これは、数十の静的メソッドを含む 3000 行を超えるコードを持つ単一の静的クラスです。Utilities.CalculateFYBasedOnMonth()からまでのすべてUtilities.GetSharePointUserInfo()ですUtilities.IsUserIE6()。適切なライブラリ セットにリファクタリングするだけで、書き換える必要のない優れたコードです。私はそれを計画しています。

これらのメソッドは新しいビジネス レイヤーに移行しており、このプロジェクトでの私の役割は、他の開発者がシステムを保守できるように準備することなので、しっかりしたコード ドキュメントについて考えています。これらのメソッドにはすべて適切なインライン コメントがありますが、XML コメント形式の適切な (またはまったく) コード doco がすべて含まれているわけではありません。GhostDoc と Sandcastle (または Document X) の組み合わせを使用して、非常に優れた HTML ドキュメントを作成し、それを SharePoint に投稿できます。これにより、開発者は、コード自体をナビゲートしなくても、コードが何をするかをより理解できるようになります。

コード内のドキュメントの量が増えると、コードをナビゲートするのが難しくなります。//commentXML コメントを使用すると、たとえば、各メソッドを単純にするよりも、コードの保守が難しくなるのではないかと考え始めています。

これらの例は、ドキュメント X サンプルからのものです。

と：

だから私はあなたから疑問に思っていました: NDoc (RIP) や Sandcastle のようなものを使用することを目標に、すべてのコードを XML コメントで文書化していますか? そうでない場合、ドキュメントを取得するものと取得しないものをどのように決定しますか? API のようなものには明らかに doco がありますが、別のチームに引き渡して維持するコードベースについてはどうでしょうか?

私は何をすべきだと思いますか？

私のチームは、大規模システム用の API の開発を担当しており、それも作成しています。API を使用している他の開発者がその使用方法を学習できるように、サンプル コードを提供する必要があります。xml ドキュメント コメントを使用してコードを文書化してきました。例えば。

次に、Sandcastle を使用して、必要なヘルプ ファイル (chm とオンライン Web サイト) を作成します。

サンプル コードが機能しないのは非常に恥ずかしいことですが、これは通常、一部の機能が変更されたか、単純なエラーが原因です。

誰かがこのようなことをしたことがありますが、ビルド中に動作することがわかっているように、サンプルコードで実行するように単体テストを構成しましたか?

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

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