Question

在阅读一些Android示例时，我通常会看到像

这样的评论

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

然而，我目前的IDE - Android Studio 1.1 - 无法识别它们（或者我做错了什么）。我想，它们可以作为某种代码区域标记（比如

）

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

在AndroidStudio / IntellijIDEA中），但这种语法很像c ++预处理程序指令。所以问题是：我是否应该知道这些评论的重要内容（除了明显的评论功能），这些评论可以以任何方式改进我的代码？

Answer 1

用于文档目的，用于标识要包含在目标文档中的片段。编辑代码时它并不是很有用;通过从实际代码生成文档来避免重复是有用的。

{@ sample}和{@include}

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

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

@sample标记


复制给定文件中的文本并删除前导和尾随空格

将文本的缩进级别降低到第一个非空白行的缩进级别

逃脱所有＆lt ;,＆gt ;;和＆amp; html的字符

删除包含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}

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

Android示例评论BEGIN_INCLUDE END_INCLUDE

1 个答案: