Java注释困境

Question

这是我的一个作业问题：

以下哪种方式不适用于标记注释？为什么？

- /** comment */ - /* comment */ - // comment - // comment comment - /*comment comment */

说实话，它们都看起来很好。但我认为可能是/** comment */，因为在示例中它不是多行的，但它的目的是文档化。你觉得呢？这是唯一让我头疼的问题。任何帮助都将不胜感激！谢谢。

- Salma

---

第一个可能会出现在你的javadoc中，取决于它的位置。 - assylias

Answer 1

就语法而言，以上任何一种表示注释的方式都是不可接受的。然而，为了让其他人更容易理解你的代码，我建议遵循一些主要的编码风格。

例如，Oracle编码风格 是Java的流行编码风格之一。

在其编码风格中，有两种类型的注释。第一种是实现注释，它使用/* */进行块注释和//进行单行注释。

    /*
     * Here is a block comment.
     */


    // Here is a single line comment.

第二种类型是文档注释，通常使用/** */样式的注释，并且只出现在类、函数和变量定义之前。例如：

    /**
     * Documentation for some class.
     */
    public class someClass {

      /**
       * Documentation for the constructor.
       * @param someParam blah blah blah
       */
      public someClass(int someParam) {
        ...
      }
      ...
    }

- keelar

Answer 2

第一条：

 /** comment */

这种类型的注释是为了文档记录而存在的。来源： http://journals.ecs.soton.ac.uk/java/tutorial/getStarted/application/comments.html

我特别指出这一点，因为它与其他类型的注释不同。虽然你可能对多行注释是正确的。

- Faahmed

---

这怎么会成为“不适当的注释方式”呢？ - Daniel Kaplan

这取决于“不可接受”的含义。是指出现错误，还是指它没有被用于其适当的目的。 - Faahmed

Javadoc不同于代码中的注释，因此使用Javadoc格式来表示常规的代码内注释是“一种不可接受的注释方式”。希望这可以帮到您。 - Scott Shipp

@ScottShipp +1，感谢您为我表达清楚。 - Faahmed

我明白你们的意思。谢谢你们的帮助！ - Salma

Answer 3

Java语言规范规定了两种注释方式，分别是“//”和“/* ... */”。

这是一个有技巧性的问题。但由于JavaDoc工具使用/** … */来创建JavaDocs，所以我认为第一种选择不是可接受的答案。

参考链接：http://docs.oracle.com/javase/specs/jls/se5.0/html/lexical.html#3.7

- raminr

---

尽管现在我想了想，可能问题格式不正确，第四个选项暗示着多行注释，也就是说第二个“注释”在没有“//”前导的情况下位于另一行。因此，如果是这种情况，那么这是不能接受的答案。 - raminr

Answer 4

你应该将这个放在一个 Java 文件中编译，然后查看哪个会出错。你不必推理就能猜到答案。

- Daniel Kaplan