logo标签列表

Java中的行内注释：/** 与 /* 有什么区别？

javaeclipsecommentsjavadoc
3

写Java内联注释像这样，有理由让我更喜欢吗：

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

与只使用一个*相反：

/* i'm a happy comment */

Eclipse会使用不同的颜色突出语法，但是在使用/** */时，“工具链”（javadoc、eclipse等）中是否真的有任何优势呢？
8个回答
10

内联注释没有必要。

/** 信号告诉 javadoc 实用程序自动提取有关您的 API 的文档。它在方法内部使用时没有任何影响。

9

常规注释

/* 常规注释 */

使用常规注释可以解释算法中的棘手部分，或者任何您不希望成为JavaDOC一部分的内容。内联注释也是常规注释，可以在描述较短时使用。

Java文档

/** JAVA DOC COMMENT */

使用javadoc可以解释类、方法或字段（变量）。

然后，大多数IDE（如Eclipse）可以使用此信息在编码时帮助您。 例如，如果您有一个classA和一个classB，并且在classB中使用了来自classA的东西，则如果您将鼠标悬停在方法或变量上，您可以看到JavaDOC信息。非常方便。

此外，使用像ant这样的构建工具，您可以自动从JavaDOC构建HTML文件，并且如果您发布它们，您可以允许其他人重复使用您的工作。 例如，查看Java本身的文档here。

4

评论的语法是/* */。

Javadoc默认使用/** */。这是一个注释，因为第二个*在注释内部，所以编译器不会对其产生不同的看法。

如果没有第二个*，那么你只是添加了一个注释；而有第二个*可以编写Javadoc：Eclipse将识别它，并在其他地方悬停在函数调用上时给出提示等。

4

/** .... */会生成Javadoc，/* ... */则不会。

当然，在正确的位置上才会生成Javadoc。Javadoc也有一个非常明确的格式，请参见这里。

3
< p > /** 表示“文档”注释；Javadocs等在创建您的代码文档时会查找这些注释。

因此，它们应该只用于方法和类上方，例如：

/**
 * Class to represent tigers.
 */
class Tiger {
    /**
     * Go extinct.
     */
    void goExtinct() {
    }
}
< p > /*变体仅表示标准注释块。

2

是的，这是使用Javadoc注释的符号：/** 主要句子。其他描述... */。第一句话直到。将用于Javadoc摘要，其余部分用于详细视图。

2
Javadoc对待/**的方式不同；拥有/**注释的类和方法将被放入javadoc输出中。
0
如果您使用引用格式（例如{@link ClassA}）并在Eclipse中重命名类ClassA，则如果它是javadoc注释，它将自动更新注释。
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接