Was ist der Unterschied zwischen/* ... */und/** ... */

Question

Ich habe bemerkt, dass Eclipse-Druck diferent Formate Kommentare:

/* Eclipse prints it in green 
*/ 

oder wenn Sie schreiben:

/** Eclipse prints it in blue 
*/ 

Was ist der Unterschied zwischen diesen beiden Arten von Kommentaren?

Answer 1

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

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

Hier ist ein Auszug aus Wikipedia über Javadoc:

Ein Javadoc-Kommentar wird von Code durch Standard mehrzeiligen Kommentar tags/* und */aufrechnen. Das öffnende Tag (Begin-Comment-Delimiter) hat ein zusätzliches Sternchen, wie in/**.

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) 

Klassenstufe Javadoc Beispiel:

/** 
* @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 
} 

Methode Ebene Javadoc Beispiel:

/** 
* 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

/* ... */ 

ist einfach ein Kommentar.

/** ... */ 

ist ein javadoc, die seltsam genug genannt, kann dann, javadoc durch ein Werkzeug in eine schöne HTML-Dokumentation umgewandelt werden. Dieses Tool berücksichtigt den Javadoc-Kommentar selbst, die Deklaration der Klasse/Schnittstelle/Methode und alle anderen Super-/Unterklassenimplementierungen/-verträge (bei der Erstellung der Informationen "spezifiziert durch" und "überschreibt" beispielsweise über Methoden). Das bemerkenswerteste Beispiel hierfür ist die Java SE API doc itself.

Dieser Dokumentationskommentar enthält ein eigenes Markup, z. B. @see Bar. Sie kann programmatische Überlegungen wie Methodenparameter und ihre Beschreibungen, den Rückgabetyp der Methode, die Ausnahmen, für die die Methode deklariert wird, und die Umstände, unter denen sie ausgelöst werden, und andere Informationen angeben.

Zum Beispiel ArrayList#toArray() dokumentiert als

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

Gibt ein Array alle Elemente in dieser Liste in der richtigen Sequenz enthält (vom ersten bis zum letzten Element); Der Laufzeittyp des zurückgegebenen Arrays ist das des angegebenen Arrays. Wenn die Liste in das angegebene Array passt, wird sie dort zurückgegeben. Ansonsten wird ein neues Array mit dem Laufzeittyp des angegebenen Arrays und der Größe dieser Liste zugeordnet.

Wenn die Liste mit Raum im angegebenen Array paßt zu schonen (d.h. die Array mehr Elemente als die Liste hat), wird das Element in dem Array unmittelbar nach dem Ende der Auflistung auf null gesetzt.(Diese ist nützlich, um die Länge der Liste der Bestimmung nur dann, wenn der Anrufer weiß, dass die Liste keine Null-Elemente enthält.)

definiert durch:
toArray in Interface-Sammlung
definiert durch:
toArray in Schnittstellenliste
Überschreibungen:
toArray in der Klasse Abstract
Typ Parameter:
T - der Laufzeittyp des Array, das die Sammlung
Parameter enthalten:
a - das Array, in dem die Elemente der Liste gespeichert werden, wenn es groß genug ist; andernfalls wird ein neues Array desselben Laufzeittyps für diesen Zweck zugewiesen.
Returns:
eine Anordnung der Elemente der Liste
Wirft enthält:
ArrayStoreException - wenn der Laufzeittyp der spezifizierten Array nicht ein übergeordneten Typ des Typs, die Laufzeit ist von jedem Elemente in dieser Liste
NullPointerException - wenn die angegebene Array ist null

von

/** 
* 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

Sie sind 3 Arten von Kommentaren in java:

Einzel ligne Kommentar

// This is a single line comment 

Multi-line Kommentar

/* This is a 
multi-line comment */ 

Dokumentations

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

Der Compiler wird sie alle ignorieren, aber das Javadoc-Tool wird Doc-Kommentare für die Generierung von Javadoc verwenden, Sie können dort HTML Formatierung verwenden. Sie können auch Tag wie @see oder @author verwenden