2010-09-16 12 views
13

Prima metodi Java abbiamo qualcosa di simile:Cosa sono chiamate docstring in java?

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

Questo ha un nome (come docstring in Python)?

risposta

14

In realtà, essi sono chiamati documento commenta e javadoc è uno strumento per generare quei commenti in HTML.

È possibile trovare la struttura del commento Javadoc in Wikipedia (ad esempio).

6

Sì, si chiama javadoc.

+2

No, javadoc è lo strumento che li elabora. Sono chiamati commenti del doc. –

+0

@seanizer è ovviamente il motivo per cui le pagine generate utilizzando lo strumento javadoc vengono in genere chiamate "javadoc" e persino perché Eclipse e altri IDE hanno viste specifiche chiamate "Javadoc" utilizzate per visualizzare solo quei "commenti doc". – Riduidel

+0

hey, io chiamo JavaDocs me stesso, ma non è il nome ufficiale. E il documento ufficiale dietro il link * tu * fornito ha il titolo "Come scrivere commenti di un documento per lo strumento Javadoc", non "Come scrivere commenti Javadoc" –