XMLコメントを付けているので、Compact Framework2.0用に作ったプログラムならXMLファイルも同時に出力される。
そこで、ソースのヘルプファイルを作るべく、NDocでドキュメントヘルプファイル(chm)に変換すれば簡単に作れるはず…ともくろんでいたんだけど、エラーで動いてくれない(T.T)
NDocは開発終了していて、.Net 2003までしか対応していない。ただ、NDocのconfigファイルにランタイムバージョンを追加してあげれば、.Net 2005でも動くはず何だけど、やっぱり動いてくれない。以前Windows用に作ったプログラムでは動いたはずなので、Compact Framework用ではまた話が違うんだろうか…
http://www.failuresoft.com/report/ndoc/ndoc13_dotnet20.html
NDoc 1.3.1 - .NET 2.0 対応(faliuresoft.com様)
NDocの設定を色々変えたりで試行錯誤の挙句、断念。
Sandcastleが.Net 2005に対応しているらしいのでそちらを使うことに変更。
ただ、コマンドラインを使うのと設定が難しいらしいので、次のページオーナーさんお勧めのSandcastle Help File Builder を自分も使うことにした。
http://d.hatena.ne.jp/Wacky/20070108/1168237297
Sandcastle Help File Builder を使って、ソースコードからドキュメントを自動作成しよう (ふにゃるん様)
んで、Sandcastle＋Sandcastle Help File Builderにて、試行錯誤の上何とか成功＼(^^)／
■Sandcastleの入手方法
http://www.codeplex.com/Sandcastle
右上の Current Release 一覧にある [Sandcastle January 200...]リンクをクリック
ページ中くらいの Files 一覧にある [Sandcastle Installer]リンクをクリックでダウンロード。
■Sandcastle Help File Builderの入手方法
http://www.codeplex.com/SHFB
右上の Current Release 一覧にある [1.6.0.4 Production]リンクをクリック
ページ中くらいの Files 一覧にある [Sandcastle Help File Builder Installer]リンクをクリックでダウンロード。
最初、MicrosoftのページにあったSandcastleの2007を入れたんだけど、バージョンが古いと怒られて失敗。2008を入れないと駄目みたい。
■Sandcastle Help File Builderの使い方
(1)両方インストールすると、スタートメニューに[Sandcastle Help File Builder]ができるので、[Sandcastle Help File Builder GUI]をクリックして実行。
(2)Addボタンで自作したプログラムのDLLまたはEXEファイル(プロジェクトのBinの中のDebugまたはRelease)を選択する。
(3)Namespacesボタンを押すと、保存するプロジェクト名を聞かれるので適当に入力する。
プロジェクト名のネームスペースを選択する。
(4)Project Properties一覧の Help File｜Language を日本にする。(その他の設定は下の※１参照)
(5)イメージボタンリストの[Build the help file]ボタンを押す。
でchmファイルが作成されるはず。
※１ その他の設定
[Help File | CopyrightHref]
URLリンクが各ページの下部に表示される。
[Help File | CopyrightText]
CopyrightHrefで指定したURLリンクの表示テキスト。
[Help File | FeedbackEMailAddress]
Eメールアドレスが各ページの下部に表示される。
[Help File | HelpTitle]
ヘルプのタイトル。変えてあげないと、タイトルがデフォルトのままで味気ない。
[Help File | SyntaxFilters]
対象の言語。VBソースのヘルプを作りたかったんで、VisualBasicを選んだ。
[Paths | OutputPath]
chmファイルが出力されるフォルダ。
[Show Missing Tags]
出力するタグ名。Remarksも記述してたので、Trueに変更した。
[Visibility]
PublicとかPrivateとか、対象の関数や変数種別。
5年以上前に買った私のパソコンでは初期設定だと45分以上かかった(^^A;
Framework系がTrueになってると時間がかかるので、初期状態でONになってた[DokumentInheritedFrameworkMembers]の選択をFalseにすれば、継承系の関数などは出なくなるが、15分に短縮された。
VBのModuleを出力するときは、明示的にPublicを付けないと(Public Module XXX)、Private扱いになってPublic関数として出力されないみたい。