問題タブ [sandcastle]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
c# - サンドキャッスルを使用してサンプルコードをドキュメントに入れる
サンドキャッスル ヘルプ ファイル ビルダーを使用して、C# コードの xml コメントからドキュメント ファイルを生成しています。msdn スタイルのように、コード例をヘルプ ファイルに含める方法を知っていますか?
sandcastle - Sandcastle Help File Builder を使用した番号付きリスト
Sandcastle Helpfile Builder で chm を作成するときに、xmldoc ブロック内のリストを順序付きリストとしてレンダリングするにはどうすればよいですか?
以下は機能しません。
私が解決しようとしている特定のケースでは、リストは <summary/> 要素内にあります。
javascript - Sandcastle - リンク切れ、「アクセスが拒否されました」などの問題
(GUI ビルダーを使用)
これが Html Help 2.x 機能セットから何を望んでいるのか、誰にもわかりませんか?
「ms-help://hx/hxruntime/hxlink.htc」を指定して、生成したローカル以外の .chm ファイルで「アクセスが拒否されました」というエラーをスローし続けます。生成された Web サイトでも同じエラーが発生します。ハードドライブ以外の場所に .chm を生成すると、ファイルが後でどこに移動されても、すべてのリンクが無効になるという事実には立ち入らないでください。
はぁ
私がイライラするのは、Microsoft のサイト (2008 年 5 月) から Sandcastle を新たにダウンロードして使用していることです。そのため、古いバージョンであるというわけではありません。ここで何か大きなものを見逃しているだけですか?
documentation - Sandcastle のドキュメント Web サイトに MSDN のようなリンクを作成するにはどうすればよいですか?
Sandcastle を使用してプロジェクトの Web サイト ドキュメントを作成しました。このウェブサイトはフレームを使用しているため、サイトをクリックしてもブラウザの URL は変わりません。
Sandcastle で生成された Web サイトのドキュメントを参照するときに、ブラウザーで URL を変更したいと考えています。なんで?開発者環境の他の部分からドキュメントの具体的なサブページにリンクしたいからです。
さらに、このリンクを永続的にしたいと考えています。したがって、プロジェクトの新しいバージョンからドキュメントをもう一度生成しても、リンクは変更されないため、すべてのリンクを新しいものに変更する必要はありません。
これは可能で、これを達成する方法は?
c# - SandcastleはSEOに適したページとリンクを作成するように構成できますか?
デフォルトでは、SandcastleがGUIDで名前が付けられたHTMLページとリンクを生成していることがわかります。どういうわけかこれを変更して、ページのユーザー/ SEOフレンドリーな名前を生成できますか?つまり。代わりに、 .Net MSDNドキュメントf987d4ff-cabc-10af-86cd-620978605d86.htm
の生成方法と同様に、「namespace.class.method.htm」を作成します。
out-of-memory - SandCastleとOutOfMemoryException
SandCastleは、XSL変換中にOutOfMemoryException例外でクラッシュするため、クラスライブラリを処理できません。
明らかなことを除いて、より多くのメモリを購入することを除いて、私たちはそれについて何ができますか?問題は、これが32ビットOS上に3.3GBのメモリを搭載した開発者のマシンであるため、基本的に64ビット以上のメモリにアップグレードするか(しばらくは発生しません)、仮想サーバーを次のようにセットアップする必要があることです。大量のメモリを使用してこれを実行します(これは本番サーバーに影響します)。
ヘルプファイルを必要とする世界最大のクラスライブラリがあるのではないかと真剣に疑っています。では、どのようなオプションがありますか?オフにするのを忘れた魔法の「メモリ不足エラーでクラッシュしない」設定はありますか?
.net - Sandcastle トピックのグループ化
Sandcastle を使用して、ビルド プロセスでソース コード ドキュメントを生成しています。これは、クラス、メソッド、プロパティなどの API レベルのドキュメントを作成するのに最適です。さらに、Sandcastle を使用すると、名前空間と「概念コンテンツ」に要約を追加できます。さまざまな「ハウツー」トピックやアーキテクチャ図などの概念コンテンツ ファイルを作成しています。これはすべてうまく機能しています。
Sandcastle でこのコンテンツをグループ化する方法があるかどうかは誰にもわかりませんか? デフォルトでは、Sandcastle は、この API ドキュメントのすべてを、ヘルプ ツリーのルートと概念的なコンテンツの両方に作成するようです。ツリーに「API ドキュメント」のようなノードを作成し、そのノードの下にすべてのソース コード ドキュメントを配置してから、他のドキュメント トピックのグループを作成したいと考えています。Sandcastle でこれを行う方法を見つけるのに苦労しています。他の商用製品の chm ファイルにこのタイプのグループ化があるのを見たことがありますが、RoboHelp のようなものを使用していると思われます。
サンドキャッスルでこれを達成する方法はありますか?
c# - Sandcastle で API ドキュメントを生成するための優れたクイック スタート ガイドはありますか?
Sandcastle を使用して API ドキュメントを生成する予定です。Web サイトでこれを行う方法に関するガイドが見つかりませんでした。誰かが推奨するクイックスタートガイドはありますか?