Android示例注释开始\u包含结束\u包含

在阅读一些android示例时，我通常会看到这样的评论

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

然而，我目前的IDE——Android Studio 1.1——无法识别它们（或者可能我做错了什么）。我猜，它们充当某种代码区域标记（如

//
//一些代码
//

---

>在ANDROIDStudio/ItLeLjJeDy中，但这种语法很像C++预处理器指令。因此，问题是：除了明显的注释功能外，我是否应该知道这些注释的一些重要信息，以便以任何方式改进我的代码？

它用于文档目的，用于识别要包含在目标文档中的代码段。在编辑代码时，它并没有真正的用处；通过从实际代码生成文档来避免重复非常有用

{@sample}和{@include}

这些标记将示例文本从任意文件复制到输出javadoc html中

@include标记逐字复制给定文件中的文本

@sample标签

• 复制给定文件中的文本，并去除前导和尾随空格
• 将文本的缩进级别降低到第一个非空白行的缩进级别
• 逃避一切；html的和字符（&C）
• 删除包含BEGIN_INCLUDE或END_INCLUDE的所有行，以便可以嵌套示例代码

两个标记都接受文件名和id，或者只接受文件名。如果未提供id，则复制整个文件。如果提供了id，将复制给定文件中包含给定id的BEGIN_INCLUDE（id）和END_INCLUDE（id）的前两行之间的行。id只能是字母、数字和下划线（）

四个例子：

{@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}

{@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}