さらば、美しい国<違っ
ヘルプファイルにサンプルコードがあると嬉しい。それも「Copy」ボタンなんて付いてて、ポチっと押したら使えちゃう、なんて言ったらもうウハウハ。
そこで、SandCatsle Help File Builder でそんなコードを乗ってるヘルプファイルを作ってみる。
<code>タグを使って、まずはサンプルコードを記述。場所は<remark>タグの中、<para>タグを使って段落っぽくレイアウトしておくと複数付けたときに適度な行間ができてなんかカッコイイ
''' <summary>
''' クラス名
''' </summary>
''' <remarks>
''' クラスの説明。
''' <example>
''' <para>
''' サンプルの概要説明。
''' <code>
''' Dim FileGen As FileGenerate = New FileGenerate("hoge.txt","c:\")
''' FileGen.Generate(ds)
''' </code>
''' </para>
''' </example>
''' </remarks>
Public Class FileGenerate
こんなカンジでソースができたら、XMLファイルを作るためにリビルド。ここまで一緒ね。
ソースがC#の場合、デフォルトがC#の記載になっているので何もしなくて良いのだけど、VBな人はここで細工が必要。Help File Builder からSandCatleへ渡す際の雛形情報ファイルあって、これに対して「VisualBasicなサンプルにするんでよろしく~」というタグを埋めておかないといけないのですですよ。
で、サンプルをVB化(笑)。まずはHelp File Builderのプロパティで、PresentationStyle の値を確認。自分で雛形を作っていない場合は、「ProtoType」「Hana」「VS2005」のどれかじゃないかと思うのですが、それぞれのPresentationStyleごとに雛形情報ファイルがあるんで、自分の選択したものにあわせたファイルを探します。
Help File Builderのインストール先ディレクトリ配下に「Templates」フォルダがあるから、ここに、
prototype.config
Hana.config
VS2005.config
というファイルがあるのを確認。無かったら探して(おい)で、ここから「ワタシゴノミのHELPファイル(はぁと)」にしたいファイルを選んでテキストエディタで開いて、
Code block component configuration
エレメントを探します。このブロック内の colorizer タグのパラメータ、language がデフォルトでは「cs」なのですが、これを「vb」に変更すると、「サンプルコード用タグ<code>の記載はVB.NET用ってことでよろしく♪」となるわけなので、書き換えたら保存して、先ほどビルドしたexe(dll)とxmlをセットしてHelpファイルをリビルド。すると<code>タグで設定したサンプルコードが「VB.NET」用として表示されます。うーん、かっちょええ。
ちなみにHelpによると、languageパラメータは以下のものが使えるとの事です。実際には、これらの分岐をコントロールしているxmlファイルもいるので、ここに色々と書き足せばもっとカスタマイズできるんじゃないかと思います。csとvb以外は試してないけど(汗)
Language ID |
Used |
cs |
C#, CSharp C# |
cpp |
C++, CPlusPlus C++ |
c |
C |
jscript |
JavaScript JavaScript |
vbnet |
VB.NET, VB VB/VB.NET |
vbscript |
VBScript |
xml |
xsl XML |
jsharp |
J# J# |