2011-07-07 10 views
4

qt examplesフォルダー内のこの特別なコメントをどういう意味ですか?QT特別なコメント//:// [num] etc

私は「//:」について知っています。これは、次の行にtr( "")が含まれている場合、翻訳プログラムのコメントよりも高いコメントです。

// []間のコードは、生成されたhtmlドキュメントに反映されているようです。

特別なコメントの詳細な説明が書かれていますか?

+0

あなたはそれを見ましたか? –

+0

私は、qt _/examples_フォルダのほぼすべてのソースで '// [10]'のようなコメントを見ました。私は '10'がタグだと思う。また、このコメントはヘルプ作成パーサによって解析され、タグ関連のコンテンツをカットしてドキュメントに貼り付けると考えています。 – egor7

答えて

5

しかし//[num]のは言及しない......。 [OK、DoxygenはQtのコメント特殊コマンドを拡張しています。]特別なコマンドは、コード上で実行されたドキュメンテーションの生成を制御するために使用されます。 Qtを管理するTrollは、コードから文書を生成するために使用する独自のツールを持っています。 Doxygenは単なる死体を私たちが使えるツールにするために書かれたものです。

Doxygenでできることの1つ(と私はQtのツールと仮定します)には、ドキュメントのサンプルコードが含まれています。多くの場合、コードの一部のみが必要なので、ファイルのどの部分を表示するかを制御するために使用できる特別なコマンドがいくつかあります(たとえば\line)。彼らはコード内のマーカーを見つけることに頼っています。 IMHO、// [xx]は単にそれらのマーカーです。

関連する問題