みみたんのメモWiki

ソフトウェア/Sandcastle Help File Builder

最終更新：2019年11月11日 13:33

匿名ユーザー

- view

管理者のみ編集可

Sandcastle Help File Builder

.Net FrameworkでのXMLドキュメントコメントをHTMLファイルや、
ヘルプファイルに変換するためのソフトウェア Sandcastle の支援ソフトウェアです。
私は、このソフトウェアを使用して自分の作ったライブラリの説明書を自分のために作ってます（笑）
Sandcastle Help File Builderの配布ページこちらです。

このソフトウェアいいのですが、英語なので設定がよくわからないって方のため＆自分のために、説明を作成しました。
適当なので、参考程度にお願いします。
使用してないってところは、ようはためしてないのでわからないってことです。

メイン画面のAssemblies to Documentへ。
メイン画面のProject Propertiesへ。
メイン画面のOutputへ。

メイン画面

Assemblies to Document(アセンブリとドキュメントの設定)

「Add」ボタン

アセンブリまたはXMLドキュメントを指定して追加する

「Edit」ボタン

選択されたアセンブリまたはXMLドキュメントを編集する

「Remove」ボタン

選択されたアセンブリまたはXMLドキュメントを削除する

「Pri Summary」ボタン

使ったことがないのでわからない。

「Namespace」ボタン

XMLドキュメントでは設定できない名前空間にコメントをつける。

説明のトップに戻る

Project Properties(プロジェクトごとの設定)

Additional and Conceptual Content

プロパティ名	プロパティの設定例	説明
AdditionalContent	(None)	使ったことなし
ConceptualContent	(None)	使ったことなし
ContentPlacement	AboveNamespaces	使ったことなし

Build(ビルドの設定)

プロパティ名	プロパティの設定例	説明
BuildLogFile		ビルドしたログファイルの保存場所
CleanIntermediates	True	使ったことなし
ComponentConfigurations	(None)	使ったことなし
CppCommentsFixup	False	使ったことなし
Dependencies	(None)	使ったことなし
FrameworkVersion	3.5	.Net Frameworkのバージョン
HelpFileFormat	HtmlHelp1x	作成するHELPファイルのフォーマット
KeepLogFile	True	ログファイルを保持するかどうか
PlugInConfigurations	(None)	プラグイン関連？(使ったことなし)

Help File(ヘルプファイルの設定)

プロパティ名	プロパティの設定例	説明
CopyrightHref	http://mimitan.shakunage.net/	コピーライトのリンク先
CopyrightText	みみたん	コピーライトの文字列
FeedbackEMailAddress	hoge@hoge.com	フィードバックを送信する送信先のメールアドレス
FeedbackEMailLinkText		フィードバックを送信するメールのテキストのリンク文字列
FooterText		フッターに表示するテキスト
HeaderText		ヘッダーに表示するテキスト
HelpTitle	みみたんクラスライブラリ	ヘルプのタイトル
HtmlHelpName	MimitanClassLibrary	ヘルプファイルのファイル名
IndentHtml	False	使ったことなし
Language	日本語（日本）	ヘルプファイルの言語
NamingMethod	Guid	使ったことなし
Preliminary	False	ドキュメントが仮のバージョンかどうかを示す文字列を表示するかどうか
PresentationStyle	vs2005	作成するヘルプファイルのスタイル
ProjectLinkType	Local	使ったことなし
RootNamespaceContainer	True	ルート名前空間を一覧を表示するページを作成するかどうか
RootNamespaceTitle	MimitanClassLibrary	ルート名前空間を一覧を表示するページのタイトル
SdkLinkTarget	Blank	SDKのリンクをクリックしたときのターゲット(HTMLのアンカー(A)のtaget要素の値だと思われる)
SdkLinkType	Msdn	SDKのリンク先のアドレス
ShowFeedbackControl	False	フィードバックコントロールを表示するかどうか
SyntaxFilters	Standard	言語フィルタを作る言語

HTML Help 1(HTML Help v1の設定)

プロパティ名	プロパティの設定例	説明
Binary TOC	True	使ったことなし
IncludeFavorites	False	使ったことなし

HTML Help 2(HTML Help v2の設定)

プロパティ名	プロパティの設定例	説明
CollectionTocStyle	Hierarchical	使ったことなし
HelpAttributes	3 attribute(s)	使ったことなし
HelpFileVersion	1.0.0.0	ヘルプのバージョン
IncludeStopWordList	True	使ったことなし
PlugInNamespaces	ms.vsipcc+, ms.vsexpresscc+	使ったことなし

Paths(さまざまなフォルダパスの設定)

プロパティ名	プロパティの設定例	説明
HtmlHelp1xCompilerPath		ヘルプコンパイラv1のコンパイラのフォルダパス（標準のフォルダパスならば空白を指定し、独自ならばフォルダパスを指定する）
HtmlHelp2xCompilerPath		ヘルプコンパイラv2のコンパイラのフォルダパス（標準のフォルダパスならば空白を指定し、独自ならばフォルダパスを指定する）
OutputPath	.\Heml\	ヘルプを出力するフォルダ（プロジェクトを保存した位置からの相対パスで指定可能らしい）
SandcastlePath		Sandcastleのフォルダパス（標準のフォルダならば空白を指定し、独自ならばフォルダパスを指定する）
WorkingPath		作業フォルダを指定する（標準でよければ空白をしていし、独自に指定したいらばフォルダパスを指定する）

Show Missing Tags(エラータグを表示するかどうかの設定)

プロパティ名	プロパティの設定例	説明
AutoDocumentConstructors	True	使ったことなし
ShowMissingNamespaces	True	名前空間でエラーが発生したことを示すタグを表示するかどうか
ShowMissingParams	True	パラメータでエラーが発生したことを示すタグを表示するかどうか
ShowMissingRemarks	False	Reamrk タグでエラーが発生したことを示すタグを表示するかどうか
ShowMissingReturns	True	返り値(Return)でエラーが発生したことを示すタグを表示するかどうか
ShowMissingSummaries	True	Summaries？でエラーが発生したことを示すタグを表示するかどうか
ShowMissingValues	False	Value？でエラーが発生したことを示すタグを表示するかどうか

Visibilty(表示設定の設定)

プロパティ名	プロパティの設定例	説明
ApiFilter	(None)	使ったことなし
DocumentAttributes	False	使ったことなし
DocumentExplicitInterfaceImplementations	False	使ったことなし
DocumentInheritedFrameworkInternalMembers	False	使ったことなし
DocumentInheritedFrameworkMembers	True	使ったことなし
DocumentInheritedFrameworkPrivateMembers	False	使ったことなし
DocumentInheritedMembers	True	使ったことなし
DocumentInternals	False	使ったことなし
DocumentPrivateFields	False	使ったことなし
DocumentPrivate	False	使ったことなし
DocumentProtected	True	使ったことなし
DocumentProtecredInternalAsProtected	False	使ったことなし
DocumentSealedProtected	True	使ったことなし