9

私はD2007を使用しており、HelpInsight機能(D2005以降に提供)を使用してソースコードを文書化しようとしています。私は主にHelpInsightツールのヒントを機能させることに興味があります。さまざまなWebサーフィンと実験から、私は次のことを発見しました。

  1. トリプルスラッシュ(///)コメントスタイルの使用は、他の文書化されたコメントスタイルよりも頻繁に機能します。すなわち: {*! comment *}そして{! comment }
  2. コメントは、その目的の宣言の前に置く必要があります。ほとんどの場合、これはコードのインターフェースセクションにそれらを配置することを意味します。(明らかな例外は、現在のユニットの外部からアクセスできないため、実装ブロックで宣言されているタイプと関数の場合です。)
  3. 最初のコメントは関数に対するものにすることはできません。(つまり、タイプ用である必要があります。または、少なくとも、HelpInsight機能が機能する前にパーサーが「type」キーワードを認識している必要があるようです)

これらの「ルール」に従っているにもかかわらず、Help-insightが私が書いたコメントを見つけられないことがあります。1つのファイルで正しいHelpInsightツールのヒントが生成されませんが、このファイルを別のダミープロジェクトに含めると、正しく機能します。

HelpInsightを機能させるためのその他の指針/コツはありますか?

4

1 に答える 1

4

私は別の警告を発見しました(私の場合は「間違っていた」ものでした)

HelpInsight コメントを含むユニットは、明示的にプロジェクトに追加する必要があるようです。プロジェクトのコンパイル時に検索されるパスにユニットを配置するだけでは十分ではありません。

つまり、ユニットはプロジェクトの .dpr / .dproj ファイルに含まれている必要があります。(プロジェクト | [プロジェクトに追加] メニュー オプションを使用)

于 2008-09-10T23:38:48.943 に答える