2010-09-16 4 views
13

Avant méthodes Java, nous avons quelque chose comme:Que sont les docstrings appelés en 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) { 
... 
}

Est-ce que cela a un nom (comme docstrings en Python)?

Répondre

14

En fait, ils sont appelés les commentaires de document et javadoc est un outil pour générer ces commentaires en HTML.

Vous pouvez trouver la structure du commentaire Javadoc dans Wikipedia (par exemple).

6

Oui, ça s'appelle javadoc.

+2

Non, javadoc est l'outil qui les traite. Ils sont appelés commentaires de doc. –

+0

@seanizer c'est évidemment pourquoi les pages générées en utilisant l'outil javadoc sont généralement appelées "javadoc" et même pourquoi Eclipse et d'autres IDE ont des vues spécifiques appelées "Javadoc" utilisées pour afficher uniquement ces "commentaires doc". – Riduidel

+0

hey, je l'appelle moi-même JavaDocs, mais ce n'est pas le nom officiel. Et le document officiel derrière le lien * vous * fourni a le titre "Comment écrire des commentaires de Doc pour l'outil Javadoc", pas "Comment écrire des commentaires Javadoc" –

Questions connexes