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

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

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

или

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

Ответ 1

Этот довольно старый (около 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 {
    ...
}

Ответ 2

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

Как это не важно для Javadoc, вы также можете использовать версию "менее тяжелая" /* ... */.

Ответ 3

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

Ответ 4

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