2010-09-16 19 views
13

Bevor Java-Methoden haben wir so etwas wie:Wie werden Docstrings in Java aufgerufen?

/** 
* Takes a number and returns its square root. 
* @param x The value to square. 
* @return The square root of the given number. 
*/ 
public float getSqrt(float x) { 
... 
}

Enthält diese einen Namen (wie Docstrings in Python) haben?

Antwort

14

Eigentlich heißen sie Dokument Kommentare und javadoc ist ein Werkzeug, um diese Kommentare in HTML zu generieren.

Sie können die Struktur des Javadoc-Kommentars in Wikipedia (zum Beispiel) finden.

6

Yup, es heißt javadoc.

+2

Nein, Javadoc ist das Werkzeug, das sie verarbeitet. Sie werden als Doc-Kommentare bezeichnet. –

+0

@seanizer, das ist offensichtlich, warum Seiten, die mit dem Javadoc-Tool erstellt wurden, normalerweise "Javadoc" genannt werden und warum Eclipse und andere IDEs spezielle Ansichten namens "Javadoc" haben, die nur diese "Doc-Kommentare" anzeigen. – Riduidel

+0

hey, ich nenne sie selbst JavaDocs, aber das ist nicht der offizielle Name. Und das offizielle Dokument hinter dem Link * you * hat den Titel "Wie schreibe ich Doc Kommentare für das Javadoc Tool", nicht "Wie schreibe ich Javadoc Kommentare" –