2016-07-09 9 views
0

Was ist der Unterschied bei der Kommentierung ist (in Eclipse mindestens) Code wie folgt:Verschiedene Stil in Code zu kommentieren

/** 
* This is a comment 
*/ 

und diese:

/* 
* This is a comment 
*/ 

Es erscheint in einer anderen Farbe.

+0

Warum sind Sie die Räume zwischen den Sterne und die Schrägstriche, wenn Sie sie nicht wollten? Im Grunde ist '/ * dies nur ein Kommentar * /', aber '/ ** dies ist ein Javadoc-Kommentar * /' –

+0

@PeeHaa: Nein, nach dem Entfernen der Leerzeichen sind beide Kommentare. –

+0

Siehe https://docs.oracle.com/javase/tutorial/getStarted/application/ –

Antwort

3

Die erste Syntax:

/** 
* This is a comment 
*/ 

Ist ein JavaDoc Kommentar, für die Dokumentation verwendet, die von IDEs und Dokumentationswerkzeuge automatisch analysiert wird.

Ist nur ein normaler Blockkommentar, der verwendet wird, wenn Sie einen Kommentar mit mehreren Zeilen schreiben möchten.

// This is a comment 

Ist nur eine normale, einzeilige Kommentar.

Siehe die JavaDoc Documentation hier.

1

der zweite ist ein Kommentar, während der erste wäre hilfreich, wenn javaDoc jemals für Sie Programmsatz generiert wird.

Der erste Kommentar würde als JAVADoc-Beschreibung der darauf folgenden Methode erscheinen.

für Ihren Fall [2 nd ein] scheint es, dass Sie eine Methode nach dem Kommentar, die einen Paramter diese hat, die die Beschreibung des hat, ist ein Kommentar

Verwandte Themen