コメントと作成者のメモの取り込み

ソース・ファイルの中に、ヘルプ・テキストの一部にはならないコメントを入れておくと、とても便利です。コメント要素でマークされたテキストは、ヘルプタグ・ソフトウェアには常に無視されます。コメントは、自分自身や他の設計者への注意書きを付けたり、あるマークアップをファイルから取り出さずに除外するのに使用できます。

標準のコメントに加えて、作成者のメモを入力するためにヘルプタグは <memo> 要素を提供しています。メモは、レビューの間はヘルプ・トピックに表示されますが、最終的なヘルプ・ファイルの作成時には表示されません。通例、設計者はレビュー担当者に対して質問や注意書きを記述するのに <memo> 要素を使用します。

コメントを挿入するには

コメントの開始マーク (<!--) と終了マーク (-->) を次のように使用します。

   
<!-- text here is completely ignored --> 

ヘルプタグ・ソフトウェアは、<!-- と --> の間のすべてのマークアップを無視します。コメントは、別のコメントの中に入れることはできません。

例

次の例には 2 つのコメントがあります。1 つは段落の前の行で、もう 1 つはパラグラフ中の語です。

<!-- Here is my rough draft of the introduction: --> 

Welcome to my application. This software
is <!-- perhaps --> the fastest and most
efficient software you'll ever own.

作成者のメモを挿入するには

<memo> 要素を次のように使用します。

<memo>   
text <¥memo>  

デフォルトでは、<memo> 要素内のテキストはヘルプタグ・ソフトウェアには無視されます (コメントと同じ)。しかし、helptag.opt ファイルに memo オプションを追加すると (または dthelptag コマンドで memo オプションを指定すると)、ヘルプ・ボリューム内のすべてのメモがボールド・フォント表示されます。

例

アプリケーションについて記述をしているとき、プロジェクト・チームに対して質問があるとします。<memo> 要素を次のように使用してテキスト内に質問を入れることができます。

<memo>Team: Will the product also
support 32-bit characters?<¥memo> 

次のコマンドでヘルプ・ボリュームを処理すると (または helptag.opt ファイルに memo を指定すると)、メモはヘルプ・テキストにボールド・フォントで表示されます。

dthelptag  volume  memo

メモ・オプションを使用しない場合 (または nomemo オプションを使用する場合)、メモ内のテキストは無視され、ヘルプ・テキストには表示されません。