Java中的内联注解:/**与/*相反?

wwodge7n  于 2022-10-15  发布在  Java
关注(0)|答案(8)|浏览(170)

有什么理由让我更喜欢用Java编写内联注解吗?

/**Init operation */
mindControlLaser.engage();

与只使用一个*相反:

/* i'm a happy comment */

Eclipse给语法添加了不同的颜色,但在“工具链”中真的有什么东西(javadoc、eclipse等)吗?在使用/*/时给我优势?

3zwtqj6y

3zwtqj6y1#

没有理由进行内联评论。
/**向javadoc实用程序发送信号,以自动提取有关您的API的文档。当在方法内使用时,它不会有任何效果。

wi3ka0sx

wi3ka0sx2#

常规评论

/* Regular comment */
使用常规注解,您可以解释可能是棘手算法的一部分。或者任何您不想成为JavaDOC一部分的内容。内联注解也是常规注解,可以在描述较短时使用。

Java文档

/**JAVA DOC COMMENT */
使用javadoc可以解释类、方法或字段(变量)。
然后,大多数IDE(如Eclipse)可以在您编写代码时使用这些信息来帮助您。例如,如果您有一个classA和一个classB,并且在classB中使用来自classA的东西,那么如果您将鼠标悬停在方法或变量上,您可以看到JavaDOC信息。这很方便。
此外,使用像ant这样的构建工具,您可以自动从JavaDOC构建HTML文件,并且如果您发布了它们,您可以允许其他人重用您的工作。例如,查看Java本身的文档here

agyaoht7

agyaoht73#

注解的语法是/* */
默认情况下,Javadoc使用/***/。这是一个注解,因为第二个*在注解中,所以编译器看起来不会有什么不同。
因此,如果没有第二个*,您只是添加了一个注解,而使用第二个*编写的是javadoc:当您将鼠标悬停在其他地方的函数调用上时,eclipse会识别它并给您提示等。

6kkfgxo0

6kkfgxo04#

/**.... */将生成Javadoc,而/* ... */不会。
当然,它只会在正确的位置生成Javadoc。Javadoc也有一个定义得很好的格式,请参见here

wz1wpwve

wz1wpwve5#

/**表示“文档”注解;Javadoc等在为您的代码创建文档时查找这些注解。
因此,它们实际上应该仅在方法和类之上使用,例如:

/**
 * Class to represent tigers.
 */
class Tiger {
    /**
     * Go extinct.
     */
    void goExtinct() {
    }
}

/*变体只表示标准的注解块。

lkaoscv7

lkaoscv76#

是的,这是使用/**Primary sentence. Other descriptions... */的javadoc表示法。第一句话直到.将用在javadoc的摘要中,其余的将在详细视图中使用。

q0qdq0h2

q0qdq0h27#

Javadoc对/**的处理方式不同;上面有/**注解的类和方法将被放入到javadoc输出中。

aydmsdu9

aydmsdu98#

如果您使用引用格式(例如,{@link ClassA})并使用Eclipse重命名类ClassA,那么如果它是一个javadoc注解,它将自动更新注解。

相关问题