在阅读一些 Android 示例时，我通常会看到类似的评论
// BEGIN_INCLUDE (something)
// END_INCLUDE (something)
但是，我当前的 IDE — Android Studio 1.1 — 无法识别它们（或者可能是我做错了什么）。我猜，它们充当某种代码区域标记（例如
//<editor-fold desc="Region name">
// some code
//</editor-fold>
在 AndroidStudio/IntellijIDEA 中），但这样的语法很像 C++ 预处理器指令。所以问题是：我是否应该了解这些注释的一些重要信息（除了明显的注释功能之外），这些信息可以以任何方式改进我的代码？
它用于文档目的，用于识别要包含在目标文档中的片段。编辑代码时它并没有多大用处；它可以通过从实际代码生成文档来避免重复。
{@sample} 和 {@include}
这些标记将示例文本从任意文件复制到输出 javadoc html 中。
@include 标记从给定文件中逐字复制文本。
@sample 标签
- 从给定文件复制文本并去除前导和尾随空格
- 将文本的缩进级别减少到第一个非空白行的缩进级别
- 转义所有 ; html 的 and & 字符
- 删除包含 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
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)
