Java评论困境

Question

这是我的任务问题:

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

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

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

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) {
        ...
      }
      ...
    }