読者です 読者をやめる 読者になる 読者になる

hayateasdf's blog

Unity,C#, javascript,C++,python,batなど

ヘルプ作成 C#

簡単に自分のソースファイルをヘルプファイルにしたい場合、

 

まず、

///<summary>

///ほげ

///<summary>

public class Hoge

{

    static void Main(string[] args){}

}

とか作ります。

xmlで出力したデータをヘルプにするために、「///」を記述してください。

 

その後、「プロジェクト」→「プロパティ」→「ビルド」→下にスクロールして、

XMLドキュメントファイル」のチェックボックスにチェックをしてください。

 その後、ビルド。

これで、XMLの出力が完了です。

 

その後は「Sandcastle Help FileBuilder (GUI)」を使用します。

Sandcastleがヘルプを作ってくれるツールです。

「ファイル」→「New Project」で新規作成。

「Window」→「Project Explorer」を表示

表示されたProject Explorerの「Documentation Sources」を右クリック

  →Add Documentation Sourcesで上で作成したexeファイルとxmlファイルを選択して、準備完了。

(exeだけで、xmlも読み込まれたかも)

その後、ビルド「Ctrl + Shift +B」。

ビルドに成功した後に、そのヘルプファイルを見たい場合、「Ctrl + Shift + V」。

もしくは「Documentation」→「View Help FIle」→ 「View Help File」。

 

画像追加とかもできるので、試してみてね。

画像突っ込んだとき  "BuildAction" が "Content" を変更しないと表示されないっぽい?ので注意

//GUI

Sandcastle Help File Builder - Home

//参考URL

[Sandcastle Help File Builder] 画像を埋め込む方法: biac の それさえもおそらくは幸せな日々@nifty

ツールを使ったドキュメント作成技法(前編) − @IT

 

SandCastle Help File Builderのエラーについて - Yahoo!知恵袋

//日本語化する場合

sandcastle-help-file-builder-japanese-help-file-pack - Japanese help files for SHFB - Google Project Hosting