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

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

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

или 

/**
 * Copyright ...
 */
import java.util.*
....
16
coding-style comments copyright-display java javadoc

4 ответов

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

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

  • начало комментария

    /*
 * 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 {
    ...
}
10

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

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

10

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

6

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

4