【问题标题】:Can Java doc comment propagate to multiple elements, not only to first under it?Java doc 注释可以传播到多个元素,而不仅仅是它下面的第一个元素吗?
【发布时间】:2013-09-29 11:03:21
【问题描述】:

我正在向一门课程添加新内容,我想在 cmets 中获得有关该内容的简短信息。像这样:

/**
 *  Added in September, 2013
 *  ----more description---
 */
public String newA;
public int newB; 
public boolean newC
...etc

这样,描述仅适用于newA 对象,因为它是文档注释下的第一个对象。

有没有一种方法可以将相同的注释应用于newA 下的所有新属性?

这仅适用于属性,因为我将 doc cmets 添加到类和方法中没有问题。

【问题讨论】:

  • 问得好,但你为什么要这么做?如果它们相同,您应该使用数组或其他东西
  • 它们不一样。它们是字符串、布尔值和整数。将制作和编辑。谢谢
  • @sandalone:如果它们是不同的数据类型,你将如何对它们应用相同的评论?
  • 但是他们会有不同的描述
  • @Ravinder 因为我只是想知道这几个月添加了哪一个。我将在稍后阶段需要此信息。

标签: java comments


【解决方案1】:

如果它确实是您项目中的必需品,您可以使用注释。

/**
 *  Added in September, 2013
 *  ----more description---
 */
public @interface SampleAnnotation {

}

@SampleAnnotation
int i;

@SampleAnnotation
boolean b;

@SampleAnnotation
String s;

但是,您应该首先阅读注释性能。

如果变量的类型相同,您可以通过将它们放在同一行中来使用标准元素注释。

/**
 *  Added in September, 2013
 *  ----more description---
 */
int i, j;

【讨论】:

  • 什么他应该阅读关于“注释性能”的内容,以及在哪里阅读?
  • 一些基准和用例。特别是它们在 Android benchmark 的设备上速度要慢得多,所以恕我直言,我们在针对旧设备时应该非常小心地使用它。
  • 嗯,注释问题不是已经修复了吗?链接:stackoverflow.com/questions/7417426/…
  • 该链接是关于使用注释处理的框架。问题是关于用于文档目的的用户定义注释,根本不处理。因此,您的建议和链接无关紧要。
猜你喜欢
  • 1970-01-01
  • 2012-10-08
  • 2016-07-31
  • 1970-01-01
  • 2012-12-16
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多