Должен ли я использовать / * * / или / ** * / для защиты авторских прав в верхней части файла Java?

Question

В каждом java-файле есть комментарий об авторских правах, но я не знаю, какой из них использовать: /* */ или /** */?

 /*
  * Copyright ...
  */
 import java.util.*
 ...

или

/**
 * Copyright ...
 */
import java.util.*
....

Answer 1

Javadoc будет собирать /** ... */ комментариев только в том случае, если они находятся непосредственно перед тем, как любая декларация будет документирована. Объявления package (отличные от package-info.java) и import в любом случае не документированы, поэтому Javadoc не будет рассматривать комментарий в любом случае.

Поскольку для Javadoc это не имеет значения, вы также можете использовать «менее тяжелую» /* ... */ версию.

Answer 2

Этот довольно старый (около 1999 г.) Sun соглашения о кодировании документ предлагает /* */.

Более конкретно, он предлагает следующую схему для вашего файла (ов) класса / интерфейса:

• Начальные комментарии

  /*
   * Classname
   * Version information
   * Date
   * Copyright notice
   */
  

• package и import операторы
• Объявления класса и интерфейса (включая комментарии Javadoc длякласс - см. запись в таблице # 1).

Пример:

/*
 * MyClass
 *
 * v1.0
 *
 * 2011-11-29
 * 
 * This file is copyrighted in an awesome way.
 */
package com.example.mypackage;

import com.example.otherpackage;

/**
 * Javadoc comments for the class.
 */
public class MyClass {
    ...
}

Answer 3

Если вы используете /** */ инструменты для документирования захватят его, так что вам лучше его использовать:)

Answer 4

Я только что прочитал некоторые проекты Java с открытым исходным кодом, обнаружил, что все они используют /* */