4

いくつかの Android サンプルを読んでいるときに、通常、次のようなコメントが表示されます

// BEGIN_INCLUDE (something)
// END_INCLUDE (something)

ただし、私の現在の IDE — Android Studio 1.1 — はそれらを認識できません (または、何か間違っている可能性があります)。おそらく、ある種のコード領域マーク (のようなもの) として機能します。

//<editor-fold desc="Region name"> 
// some code
//</editor-fold>

AndroidStudio/IntellijIDEA 内) ですが、このような構文は C++ プリプロセッサ ディレクティブによく似ています。質問: これらのコメントについて (明らかなコメント機能に加えて) 何か重要なことを知っておく必要がありますか?

4

1 に答える 1

7

これは文書化を目的としており、対象文書に含めるスニペットを識別するために使用されます。コードを編集するときはあまり役に立ちません。実際のコードからドキュメントを生成することで、繰り返しを避けるのに役立ちます。

{@sample} と {@include}

これらのタグは、サンプル テキストを任意のファイルから出力 javadoc html にコピーします。

@include タグは、指定されたファイルからテキストを逐語的にコピーします。

@sample タグ

  • 指定されたファイルからテキストをコピーし、先頭と末尾の空白を取り除きます
  • テキストのインデント レベルを最初の非空白行のインデント レベルに減らします
  • すべての <, > をエスケープします。および html の & 文字
  • サンプル コードをネストできるように、BEGIN_INCLUDE または END_INCLUDE を含むすべての行を削除します。

どちらのタグも、ファイル名と ID、またはファイル名のみを受け入れます。ID が指定されていない場合、ファイル全体がコピーされます。ID が指定されている場合、指定された ID の BEGIN_INCLUDE(id) と END_INCLUDE(id) を含む最初の 2 行の間にある指定されたファイルの行がコピーされます。id は文字、数字、およびアンダースコア () のみです。

4 つの例:

{@include samples/SampleCode/src/com/google/app/Notification1.java}
{@sample samples/SampleCode/src/com/google/app/Notification1.java}
{@include samples/SampleCode/src/com/google/app/Notification1.java Bleh}
{@sample samples/SampleCode/src/com/google/app/Notification1.java Bleh}

https://code.google.com/p/doclava/wiki/JavadocTags

于 2015-03-17T08:24:26.990 に答える