Java评论困境

时间:2013-05-15 20:50:32

标签: java comments

这是我的任务问题:

以下哪项不是表示评论的可接受方式?为什么?

  • / **评论* /
  • / * comment * /
  • //评论
  • //评论评论
  • / *评论评论* /

老实说,他们看起来都很好。但我认为它可能是/ **评论* /因为它在示例中并不是多方面的,但这是它的目的 - 文档。你怎么看? 这是给我带来困难的唯一问题。任何帮助,将不胜感激!谢谢。

4 个答案:

答案 0 :(得分:5)

就语法而言,上述表示评论的方式均不可接受。 但是,为了让其他人更容易理解您的代码,我建议 遵循一些主要的编码风格。

例如,Oracle coding style 是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) {
        ...
      }
      ...
    }

答案 1 :(得分:2)

第一颗子弹:

 /** comment */

此类评论适用于文档。资源: http://journals.ecs.soton.ac.uk/java/tutorial/getStarted/application/comments.html

只是指出这一点,因为它与其他类型的评论不同。你可能对多线评论是正确的。

答案 2 :(得分:2)

Java语言规范声明有两种注释,“//”和“/ * ... * /”。

http://docs.oracle.com/javase/specs/jls/se5.0/html/lexical.html#3.7

这是一个棘手的问题。但是,由于JavaDoc工具使用/ ** ... * /来创建JavaDocs,我认为第一选择不是一个可接受的答案。

答案 3 :(得分:-1)

你应该将它放在一个java文件中并编译每个文件,然后看看哪一个给你错误。你无需推理它来猜测答案。