В чем разница между/* ... */и/** ... */

Question

Я заметил, что Eclipse, печатает Diferent форматы для комментариев:

/* Eclipse prints it in green 
*/ 

или если вы пишете:

/** Eclipse prints it in blue 
*/ 

В чем разница между этими двумя комментариями?

Answer 1

/* 
* It is multi-line comment in Java 
* 
*/ 

/** 
* It is a Javadoc. Can be found above methods and Class definitions. 
* 
* 
*/ 

Вот отрывок из Wikipedia о Javadoc:

Javadoc комментарий оттеняется из кода стандартной многострочный комментарий теги/* и * /. Открывающий тег (называемый разделителем начала-комментария) имеет дополнительную звездочку, как в/**.

The first paragraph is a description of the method documented. 
Following the description are a varying number of descriptive tags, signifying: 
    The parameters of the method (@param) 
    What the method returns (@return) 
    Any exceptions the method may throw (@throws) 
    Other less-common tags such as @see (a "see also" tag) 

Класс Уровень Javadoc Пример:

/** 
* @author  Firstname Lastname <address @ example.com> 
* @version  1.6     (current version number of program) 
* @since  2010-03-31   (the version of the package this class was first added to) 
*/ 
public class Test { 
    // class body 
} 

Метод уровня Javadoc Пример:

/** 
* Short one line description.       
* <p> 
* Longer description. If there were any, it would be  
* here. 
* <p> 
* And even more explanations to follow in consecutive 
* paragraphs separated by HTML paragraph breaks. 
* 
* @param variable Description text text text.   
* @return Description text text text. 
*/ 
public int methodName (...) { 
    // method body with a return statement 
} 

Answer 2

/* ... */ 

просто комментарий.

/** ... */ 

является Javadoc, которые затем могут быть преобразованы в HTML документации хороший с помощью инструмента под названием, как ни странно, javadoc. В этом инструменте рассматривается сам комментарий javadoc, объявление класса/интерфейса/метода и любых других реализаций/контрактов супер/подклассов (например, при создании информации о «указанном» и «переопределении» методов). Наиболее примечательным примером этого является Java SE API doc itself.

Этот комментарий к документации включает в себя собственную разметку, например @see Bar. Он может определять программные соображения, такие как параметры метода и их описания, тип возвращаемого метода, исключения, объявленные методом броска, и обстоятельства, при которых они будут выбрасываться, и другую информацию.

Например, ArrayList#toArray() документирована как

public <T> T[] toArray(T[] a)

возвращает массив, содержащий все элементы в этом списке в правильной последовательности (от первого до последнего элемента); тип времени выполнения возвращаемого массива соответствует указанному массиву. Если список соответствует указанному массиву , он возвращается в нем. В противном случае новый массив равен , выделенному типом среды выполнения указанного массива и размером в этом списке.

Если список помещается в указанном массиве с запасом (т.е. массив имеет больше элементов, чем в списке), то элемент массива сразу после окончания сбора устанавливается в нуль.(Это полезно при определении длины списка, только если абонент знает, что список не содержит нулевых элементов.)

Определенный:
ToArray в интерфейсе Collection
Определенный:
ToArray в интерфейсе Список
Overrides:
ToArray в классе AbstractCollection
Тип Параметры:
T - тип выполнения массива содержат свою коллекцию
Параметров:
a - массив, в котором элементы списка должны быть сохранены, если оно достаточно велико; в противном случае для этой цели выделяется новый массив того же типа времени выполнения.
Возвращает:
массив, содержащий элементы списка
Броски:
ArrayStoreException - если тип времени выполнения указанного массива не является родительским типа выполнения каждого элемента в этом списке
NullPointerException - если указанный массив нулевой

из

/** 
* Returns an array containing all of the elements in this list in proper 
* sequence (from first to last element); the runtime type of the returned 
* array is that of the specified array. If the list fits in the 
* specified array, it is returned therein. Otherwise, a new array is 
* allocated with the runtime type of the specified array and the size of 
* this list. 
* 
* <p>If the list fits in the specified array with room to spare 
* (i.e., the array has more elements than the list), the element in 
* the array immediately following the end of the collection is set to 
* <tt>null</tt>. (This is useful in determining the length of the 
* list <i>only</i> if the caller knows that the list does not contain 
* any null elements.) 
* 
* @param a the array into which the elements of the list are to 
*   be stored, if it is big enough; otherwise, a new array of the 
*   same runtime type is allocated for this purpose. 
* @return an array containing the elements of the list 
* @throws ArrayStoreException if the runtime type of the specified array 
*   is not a supertype of the runtime type of every element in 
*   this list 
* @throws NullPointerException if the specified array is null 
*/ 

Answer 3

Они 3 вида комментариев в Java:

Single Ligne комментарий

// This is a single line comment 

Многострочный комментарий

/* This is a 
multi-line comment */ 

Документация комментарий

/** 
* This is a <b>documentation comment</b> 
*/ 

Компилятор проигнорирует их все, но инструмент javadoc будет использовать комментарии doc для генерации javadoc, вы можете использовать там HTML форматирование. Вы также можете использовать теги, такие как @see или @author