SHFB (Sandcastle Help File Builder)

概要

最小限の設定

プロジェクト作成

プロジェクト作成
新規作成メニュー [File] - [New Project]
ソリューションの追加メニュー [File] - [Project Explorer] - [Documentation Sources] - [Add Documentation Source...]
各種設定プロジェクト プロパティ
保存メニュー [File] - [Save As...]
ビルドメニュー [Documentation] - [Build Project]

Build【ビルド】

項目選択項目
Presentation style
【表示スタイル】
【択一】
Markdown Contentマークダウンコンテンツ
Open XML DocumentOpen XML ドキュメント
VS2010Visual Studio 2010
VS2013Visual Studio 2013
(ユーザ定義)
Build these help file formats
【ヘルプのフォーマット】
Presentation style【表示スタイル】との組み合わせ
Presentation style
【表示スタイル】
選択項目
Markdown Content
【マークダウンコンテンツ】
Markdown (md)
Open XML Document
【Open XML ドキュメント】
Open XML (docx)
VS2010・VS2013
【Visual Studio 2010・2013】
【複数選択可】
HTML Help 1 (chm)
MS Help Viewer (mshc)
Website (HTML/ASP.NET)
(ユーザ定義)(ユーザ定義)

Help File【ヘルプファイル 共通】

項目選択項目
Help title
【ヘルプのタイトル】
【文字列】
"A Sandcastle Documented Class Library"
ユーザ指定
Help file name
【ファイル名 (パス・拡張子なし)】
【文字列】
"Documentation"
ユーザ指定
Help file language
【ヘルプの言語】
English (United States)
Japanese (Japan)

Summaries【概要】

項目選択項目
These comments will appear in the root namespaces page. ~
【プロジェクトの概要】
【文字列 (HTML可)】
(未指定) ユーザ指定
Edit the summary for the selected namespace
【名前空間の概要】


特殊クラス NamespaceDoc の利用も可
/// <summary>【名前空間の概要】</summary>
[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
class NamespaceDoc { }
【文字列 (HTML可)】
(未指定) ユーザ指定

プロジェクト プロパティ

Build【ビルド】

項目選択項目
Build these help file formats
【ヘルプのフォーマット】
Presentation style【表示スタイル】との組み合わせ
Presentation style
【表示スタイル】
選択項目
Markdown Content
【マークダウンコンテンツ】
Markdown (md)
Open XML Document
【Open XML ドキュメント】
Open XML (docx)
VS2010・VS2013
【Visual Studio 2010・2013】
【複数選択可】
HTML Help 1 (chm)
MS Help Viewer (mshc)
Website (HTML/ASP.NET)
(ユーザ定義)(ユーザ定義)
Syntax filters
【構文セクション表示対象】
【複数選択可】
ASP.NET
C#
F#
J#
JavaScript
JScript
Managed C++
Visual Basic
Visual Basic Usage
X#
XAML Usage
(ユーザ定義)
Presentation style
【表示スタイル】
【択一】
Markdown Contentマークダウンコンテンツ
Open XML DocumentOpen XML ドキュメント
VS2010Visual Studio 2010
VS2013Visual Studio 2013
(ユーザ定義)
Framework version
【フレームワーク バージョン】
【択一】
.NET Framework 4.5 等
Build log filename
【ログファイル フルパス名】
【文字列】
省略:出力パスの LastBuild.log
Fixed Path
【パス固定】
True / False
Clean intermediate files after a successful build
【中間ファイルクリーンアップ有無】
True / False
Keep the log file after a successful build
【ログファイルの保持有無】
True / False
Disable the custom code block component
【<code>要素の色付け無効】
True / False
Indent rendered HTML
【HTMLのインデント有無 (デバッグ用)】
True / False
BuildAssembler Verbosity
【ビルドメッセージ出力対象】
【択一】
All messages全て
Only warnings and errors警告・エラーのみ
Only errorsエラーのみ
Maximum Save Component writer task cache capacity
【書き込みタスクキャッシュ容量】
【数値 (0 ~ 9999)】
100
0 (無制限)

Help File【ヘルプファイル 共通】

項目選択項目
Help title
【ヘルプのタイトル】
【文字列】
"A Sandcastle Documented Class Library"
ユーザ指定
Help file name
【ファイル名 (パス・拡張子なし)】
【文字列】
"Documentation"
ユーザ指定
Help file version
【ヘルプファイルバージョン】
【文字列】
"1.0.0.0"
Help file language
【ヘルプの言語】
English (United States)
Japanese (Japan)
Topic file naming method
【トピックファイル名の命名】
【択一】
GUID
Member name
Hashed member name
Conceptual content placement
【コンテンツ配置】
【択一】
Above namespaces名前空間の上
Below namespaces名前空間の下
Include root namespace container
【名前空間コンテナの使用有無】
True / False
Title
【名前空間コンテナのタイトル】
【文字列】
Enable namespace grouping if supported
【名前空間のグループ化有無】
True / False
Maximum group parts
【名前空間グループの最大パーツ数】
【数値】
2 ~ 30
Include "preliminary documentation" warning
【<preliminary (暫定)>タグの警告表示 (赤字) 有無】
True / False
Additional header content
【ヘッダ】
【文字列 (HTML可)】
Additional footer content
【フッタ】
【文字列 (HTML可)】
Copyright notice URL
【コピーライト用URL】
【文字列】
Copyright notice text
【コピーライト用テキスト】
【文字列】
Feedback e-mail address
【フィードバック用メールアドレス】
【文字列】
Feedback e-mail link text
【フィードバック用メールリンクテキスト】
【文字列】
SDK link target
【SDKのリンク表示場所】
【択一】
Blank新規ウィンドウ (タブ)
Self現在フレーム
Parent現在フレームの親
Top元ウィンドウ全体

Help 1/Website【Help 1 / ウェブサイト】

項目選択項目
HTML Help1 (CHM)
Help 1 SDK link type
【ヘルプ1 用SDKリンクタイプ】
【択一】
Online links to MSDN help topicsMSDN へリンク
No SDK linksリンク無し
Create a binary table of contents to reduce load time
【バイナリの目次作成有無 (ロード時間短縮)】
True / False
Include a Favorites tab in the compiled help file
【[お気に入り]タブ作成有無】
True / False
Website (HTML/ASP.NET) / Open XML (DOCX)
Website/Open XML SDK link type
【ウェブサイト/ Open XML 用SDKリンクタイプ】
【択一】
Online links to MSDN help topicsMSDN へリンク
No SDK linksリンク無し
Website Ad Content
【ウェブサイト広告コンテンツ】
【文字列 (スクリプト・HTML 可)】
(フッタの下に挿入)
Markdown
Include the '.md' filename extension on markdown topic URLs
【トピックURLの".md" 拡張子追加有無】
True / False

MS Help Viewer【Microsoft ヘルプ ビューアー】

項目選択項目
Help Viewer 1.0 catalog product ID
【Help Viewer 1.0 カタログプロダクト ID】
【文字列】
"VS"【標準 Visual Studio カタログ】
Help Viewer 1.0 catalog version
【Help Viewer 1.0 カタログ バージョン】
【文字列】
"100"【標準 Visual Studio カタログ バージョン】
Help Viewer 2.x content catalog name
【Help Viewer 2.x コンテンツ カタログ名】
【文字列】
Vendor name
【セットアップファイルのベンダー名】
【文字列】
Product title
【セットアップファイルのプロダクトタイトル】
【文字列】
省略:Help title【ヘルプのタイトル】
Starting TOC sort order
【TOCソート順】
【数値】
-1
TOC parent topic ID
【TOC親トピックID】
【数値】
-1
TOC parent topic version
【TOC親トピックバージョン】
【文字列】
100
Topic version for this file
【ファイルのトピックバージョン】
【文字列】
100
Search results display version
【検索結果の表示バージョン】
MS Help Viewer SDK link type
【MSヘルプビューア用SDKリンクタイプ】
【択一】
Online links to MSDN help topics
ID links within the collection
No SDK links

Summaries【概要】

項目選択項目
Project Summary【プロジェクトの概要】
These comments will appear in the root namespaces page. ~
【プロジェクトの概要】
【文字列 (HTML可)】
(未指定) ユーザ指定
Namespace Summaries【名前空間の概要】
Filter Namespaces
Assembly
【アセンブリ】
【択一】
<All>
(自動検索)
Name Like
【検索テキスト】
[Apply]ボタン
【フィルタリング】
Checked namespaces will appear in the help file. Unchecked namespaces will not.
【表示する名前空間選択】
Selected namespace appears in
【選択名前空間】
Edit the summary for the selected namespace
【名前空間の概要】


特殊クラス NamespaceDoc の利用も可
/// <summary>【名前空間の概要】</summary>
[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
class NamespaceDoc { }
【文字列 (HTML可)】
(未指定) ユーザ指定

Visibility【表示】

項目選択項目
Include the following API elements in the documentations【表示有無】
Attributes on types and their members
【属性の表示有無】
True / False
Explicit interface implementations
【デフォルト明示的インタフェース実装の表示有無】
True / False
Inherited base class members
【継承メンバの表示有無】
True / False
Inherited .NET Framework members
【継承.NET Frameworkメンバの表示有無】
True / False
Inherited .NET Framework internal members
【継承.NET Framework内部メンバの表示有無】
True / False
Inherited .NET Framework private members
【継承.NET Frameworkプライベートメンバの表示有無】
True / False
Internal members
【内部メンバの表示有無】
True / False
Private fields
【プライベートフィールドの表示有無】
True / False
Private members
【プライベートメンバの表示有無】
True / False
Protected members
【プロテクトメンバの表示有無】
True / False
Protected members of sealed classes
【シールクラス プロテクトメンバの表示有無】
True / False
No-PIA (Primary Interop Assembly) embedded interop types
【No-PIA埋め込みinterop型の表示有無】
True / False
Public compiler generated types and members
【コンパイラ生成型 (内部構造体)の表示有無】
True / False
Types and members marked with an EditorBrowsable attribute set to Never
【EditorBrowsable属性の表示有無】
True / False
Types and members marked with a Browsable attribute set to False
【Browsable属性の表示有無】
True / False
Document "protected internal" members as "protected" instead
【内部プロテクトメンバをプロテクトメンバとみなすか否か】
True / False
[Edit API Filter]ボタン
API Filter
【個別の表示有無】
ダイアログ

Missing Tags【不足タグ】

項目選択項目
Auto-document the following class members if they are missing XML comments【自動追加】
Constructors
【コンストラクタの<summary>不足時の自動追加有無】
True / False
Dispose Methods
【Disposeメソッドの<summary>不足時の自動追加有無】
True / False
Include a "missing documentation" warning for eacch of the following XML comment elements  if they are not present on the appropriate class member【不足コメントの警告】
Namespace documentation
【名前空間コメント不足時の警告有無】
True / False
<summary> elements
【<summary>不足時の警告有無】
True / False
<param> elements
【<param>不足時の警告有無】
True / False
<typeparam> elements
【<typeparam>不足時の警告有無】
True / False
<returns> elements
【<returns>不足時の警告有無】
True / False
<value> elements
【<value>不足時の警告有無】
True / False
<remarks> elements
【<remarks>不足時の警告有無】
True / False
<include> element targets
【<include>のtargets属性不足時の警告有無】
True / False

Paths【パス】

項目選択項目
Tool Paths【ツールパス】
HTML Help 1 compiler path
【HTMLヘルプ1コンパイラ (HHC.EXE) パス】
【フォルダパス】
省略:自動検索
Project-specific components path
【プロジェクト固有コンポーネントパス】
【フォルダパス】
省略:プロジェクトフォルダ検索
Source Code Base Path【ソースコード】
If specified and your source code is hosted online,  links to it will be included in topics in presentation styles that support it (see Transform Args).
An up-to-date program database (PDB) file is required for each documented assembly.
Specify the local file system path here, not a URL.
【ソースコードがオンライン上の場合のルートソースコードローカルパス】
【フォルダパス】
Report missing type source contexts as warnings
【型情報等不足時の警告有無】
True / False
Output Paths【出力パス】
Help content output path
【ヘルプ出力パス (注意:出力前にクリア)】
【フォルダパス】
省略:.\Help
Working files path
【作業ファイルパス (注意:出力前にクリア)】
【フォルダパス】
省略:.\Working

Components【コンポーネント】

項目選択項目
Available Build Components
【使用可能ビルドコンポーネントのリスト】
【択一】
Build Components in This Project
【使用ビルドコンポーネントのリスト】
【チェックボックス】
ビルドコンポーネントの使用有無
[Add]ボタン
【ビルドコンポーネントの追加】
[Configure]ボタン
【ビルドコンポーネントの構成設定】
[Delete]ボタン
【ビルドコンポーネントの削除】

Plug-Ins【プラグイン】

項目選択項目
Available Plug-Ins
【使用可能プラグインのリスト】
【択一】
Plug-Ins in This Project
【使用プラグインのリスト】
【チェックボックス】
プラグインの使用有無
[Add]ボタン
【プラグインの追加】
[Configure]ボタン
【プラグインの構成設定】
[Delete]ボタン
【プラグインの削除】

Transform Args【変換コンポーネントの引数】

項目選択項目
【変換コンポーネントのリスト】【択一】
【対象変換コンポーネントの説明】【読み取り専用】
Used in conceptual buildTrue / False
Used in reference buildTrue / False
Value
【引数の値】

User Defined【ユーザ定義】

項目選択項目
【ユーザ定義のリスト】【択一】
[Add]ボタン
【ユーザ定義の追加】
[Remove]ボタン
【ユーザ定義の削除】
Name
【ユーザ定義名】
Condition
【ユーザ定義の使用条件】
Value
【ユーザ定義値】

Build Events【ビルドイベント】

項目選択項目
Pre-build event command line
【ビルド前実行イベント】
[Edit Pre-build Event]ボタン
【ビルド前実行イベントの編集ダイアログ】
Post-build event command line
【ビルド後実行イベント】
Run the post-build event
【ビルド後実行イベントの実行条件】
【択一】
On successful buildビルド成功時のみ実行
Always常に実行
[Edit Post-build Event]ボタン
【ビルド後実行イベントの編集ダイアログ】

関連