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) 的前两行之间的行。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

于 2015-03-17T08:24:26.990 回答