問題タブ [shfb]

プロジェクトを文書化したい。すべて正常に動作していますが、AjaxDoc を動作させることができません。

誰かがそれらの使用方法に関する短いチュートリアルを書いてくれませんか?

Visual Studio に SHFB を統合しました。次に、 http: //ajaxdoc.codeplex.com/ から WebApp プロジェクトをダウンロードし、既存の Web サイトとしてソリューションに追加しました。私はこのサイトを構築し、彼の URL を AjaxDoc プラグインに書き込みました。

現在、AjaxDoc はデフォルトで MicrosoftAjax.js からコメントを取得するように構成されており、私にとってはうまくいきます。しかし、私は自分の MyJavaScript.js を追加して Projects フォルダーに MyJavaScript.project.xml を作成しようとしましたが、うまくいきません。

JScript.project.xml:

JScript.js:

インターネットで見つけたプロジェクトからこれをコピーします...

私は何を間違っていますか？また、AjaxDoc/Projects フォルダー内のスクリプトだけでなく、自分のプロジェクトにコメントするにはどうすればよいですか?

返信ありがとうございます。

Noda Timeでは、SandcastleとSHFBを使用してドキュメントを生成します。次に、ドキュメントをソースリポジトリにコミットします。これは主に、最新の（および履歴の）ドキュメントを簡単に表示できるためです。

私はプロジェクトの主要な開発者ですが、2台のコンピューターを使用しています。残念ながら、両方とも同じソースに更新されていても、現時点では異なるドキュメントを作成しています。

2台のコンピューターは、私が考えることができるすべての重要な点で同じです。

• サンドキャッスル2.7.2.0
• SHFB 1.9.6.0
• VS 2012 Professional（両方とも「プログラム」でバージョン11.0.50727.1を報告し、両方とも「バージョン情報」ページで「バージョン11.0.51106.01アップデート1」を報告しました）
• .NET Framework 4.5のローカルヘルプコンテンツの最新バージョン（および他のフレームワークバージョンのローカルヘルプコンテンツはありません）

クリーンビルドを確実にするために取られたステップ：

• SHFBキャッシュフォルダを削除しました（C:\Users\Jon\AppData\Local\EWSoftware\Sandcastle Help File Builder\Cache）
• ドキュメントが生成されるフォルダを削除しました
• SHFBプロジェクトファイルに関連するユーザー設定ファイルを削除しました
• VisualStudioのシンボルキャッシュを削除しました

それでも違いは残っています。特に、MSDN自体から継承されたドキュメントに限定されているようObject.Finalizeです。

バージョン1（マシン「Chubby」で生成）：

バージョン2（マシン「Sandy」で生成）：

どちらも同じMSDNドキュメントにリンクしています。これはバージョン1のように見えます（へのリンクはありませんObject）。

変更されたファイルのいくつかを見ると、変更は一貫しており、このメンバーに制限されています。

Sandcastleはどこからこのドキュメントを入手できますか？また、両方のコンピューターを同じように動作させるにはどうすればよいですか？

編集：もう1つの情報の断片-両方のマシンでキャッシュをクリーンアップしてドキュメントを再構築した後、SHFBキャッシュディレクトリに3つのファイルがあります。

• Reflection.cacheは両方のマシンで同じサイズです
• MsdnUrl.cacheは両方のマシンで同じサイズです
• .NETFramework_4.0.0319_E8879A28.cacheのサイズはChubbyで13,377,733バイト、Sandyで13,337,949バイトです。

編集：重要な進歩！私は違いがおそらくどこから来ているのかを見つけました...

ファイルc:\Windows\Microsoft.NET\Framework\v2.0.50727\en\mscorlib.xml：

• チャビーでは、2011年12月12日の日付で8,005,263バイトであり、リンクされていないテキストがあります。Finalize
• On Sandyは2009年8月31日付けの9,740,370バイトで、Finalizeリンクを含むテキストがあります

両方のマシンで、mscorlib.dllそれ自体は同じサイズ（4,550,656バイト）であり、2012年9月13日の変更日があります。

しかし、どうすればそれらを同じにすることができますか？その違いはどこから来るのですか？（サービスパック？）

編集：さて、のバージョンはc:\Windows赤いニシンでした-それはc:\Program Files (x86)\Reference Assemblies\Microsoft\Framework責任があるバージョンです。インストール間でなぜそれが異なるのかを知ることができるかどうかを確認します...

ポータブルクラスライブラリ（.Net40、Silverlight 4、.Net for Windows Store、Windows Phone 7.5）のドキュメントをHTMLヘルプ1およびMSヘルプビューアーとして作成しようとしています。「ドキュメントソース」は1つしかありません。プロジェクトはvs2010ドキュメントスタイルを使用するように設定されています（vs2005スタイルにも問題があります）。Sandcastle Help FileBuilderGUIまたはVisualStudio2010のどちらを使用しても、ドキュメントプロジェクトをビルドしようとすると、常に同じエラーが発生します。

さらに調査したところ、ディレクトリはである必要があるようC:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\Templates\VS2010.configです。SHFBが試行しているディレクトリではなく、そのディレクトリにSHFBをリダイレクトするにはどうすればよいですか？

ドキュメントプロジェクトをビルドするにはどうすればよいですか？

さらなる調査を通じて、この問題はドキュメントソースがポータブルクラスライブラリであることにあると推測しました。これはSHFBのバグですか、それとも自分で修正できるものですか？

Sandcastle Help File Builder を使用して、SDK の洗練されたドキュメントを作成しています。Visual Studio のF1機能をサポートするために、出力の 1 つが MS Help Viewer 形式になっています。問題は、パッケージを Help Viewer 1.0 (Visual Studio 2010) または Help Viewer 2.0 (Visual Studio 2012) にインストールすると、ドキュメントがルート コンテナーに配置されないことです。

画像に示されている「API リファレンス」ノードは、クラス ライブラリ自体のコンテナーです。このノードの名前を変更することはできますが、そうすると、クラス ライブラリ リファレンスに加えて概念的なコンテンツを含める場所がなくなります。これを、.NET Framework 4 ヘルプの同等のノードの場所と比較してください。

質問: 他のドキュメントとの一貫性を保つために、現在の「API リファレンス」クラス ライブラリ ドキュメントがそのノードの子であるプロジェクトのユーザー指定の最上位コンテナに、Sandcastle Help File Builder で MS Help Viewer 出力を生成するにはどうすればよいですか? ?

I've a C# project that I need to create documentation file. I'm using last version of SHFB and VS 2005 to create XML documentation file.

How can I add code blocks inside documentation? I wanna show all lines of my function, not only one part for sample.

I found a document that describes how to add code block in sandcastle with code tag, but my functions dont have that tag, also in project there are a lot of functions, so its imposible to add tags for all functions.

Is there any way to build code tag from project automaticly, or a plugin for show inside of function?

Thanks.

反映されたコード セクションを (必ずしも) 含まないヘルプ システムを作成しようとしています。最新の Sandcastle Help File Builder を使用して、MAML XML ファイルのみを含めることは可能ですか?現在、私は

エラー BE0042: アセンブリまたは Visual Studio ソリューション/プロジェクト ファイルの形式で少なくとも 1 つのドキュメント ソースを指定する必要があります。

ドキュメントを生成するためにSandcastle Help File Builderをしばらく使用してきました。現在、それをビルド プロセスの一部にしようとしています。私たちのビルドは NAnt を使用して制御され、ビルドされるたびに出力が別の場所に送信されます (変更セット番号に基づいているため、衝突することなく同時ビルドを行うことができます)。つまり、dll はソース コードに関連する固定パスにありません。 .

NAnt スクリプトにターゲットを追加して SHFB を呼び出し、SHFB プロジェクトを含むソリューションを指定して msbuild タスクを呼び出します。

このページのように、ReferencePath プロパティを指定しました。これにより、元のプロジェクト ファイルの情報に依存するのではなく、SHFB がアセンブリを見つけて使用できるようになることが示されているようです。

ReferencePath プロパティが定義されている場合、リフレクション情報を生成するときに GenerateRefInfo.proj に渡されて使用されます。これにより、プロジェクト ファイル内のヒント パスをオーバーライドする参照アセンブリを見つける代替パスを指定できます。

ただし、ビルドがこの時点に達すると、次のエラーで失敗します。

SHFB: エラー BE0040: プロジェクト アセンブリが存在しません: D:\Build\Debug\wwwroot\bin\MyAssembly.dll

元のプロジェクトで指定されたデフォルトの出力パスです。

アセンブリの場所を SHFB に渡すための正しいメカニズムは何ですか?

<summary></summary>私の C# プロジェクトでは、内部クラスの前に要素があるにもかかわらず、SHFB に内部クラスの記述が含まれていません。クラスはクラス リストにも表示されますが、説明は空白です。

内部メンバーの可視性を有効にしましたが、内部クラスを有効にする方法がわかりません。何か案は？

NuGet の最新の SHFB ビルド (2014.11.22.0) を使用して、VS2013 Ultimate で開発しています。

(なぜ内部メンバー向けのドキュメントを含めたいのか疑問に思う人もいると思いますが、開発チームにとって、コード ベースのクイック リファレンスがあると便利であることが証明されています。)

Is there a way to create a list of all classes tagged with a specific (custom) tag in a Sandcastle documentation?

I'm using a custom tag to mark specific behavior in my classes. I mapped this tag in main_conceptual.xsl and the content is shown at the documentation sheet of each class.

ここで、カスタム タグでタグ付けされたすべてのクラスのリストを示す特別なページ (概念的なコンテンツとして?) をドキュメントに作成したいと考えています。サンドキャッスル ヘルプ ファイル ビルダー (SHFB) を使用してこれを行う可能性はありますか? おそらく.xsl変換で？またはMAMLを使用していますか？