web-dev-qa-db-fra.com

Dans Java quelle est la syntaxe pour commenter plusieurs lignes?

Dans Java quelle est la syntaxe pour commenter plusieurs lignes?

Je veux faire quelque chose comme:

(comment)
LINES I WANT COMMENTED
LINES I WANT COMMENTED
LINES I WANT COMMENTED
(/comment)
javacomments
15
David
/* 
LINES I WANT COMMENTED 
LINES I WANT COMMENTED 
LINES I WANT COMMENTED 
*/
55
Andrey
/* 
Lines to be commented
*/

NB: les commentaires multilignes comme celui-ci NE S'IMPOSENT PAS. Cela peut être la source d'erreurs. Il est généralement préférable de simplement commenter chaque ligne avec //. La plupart des IDE vous permettent de le faire tout simplement.

20
kgrad

Comme le dit @kgrad,/* */ne s'imbrique pas et peut provoquer des erreurs. Une meilleure réponse est:

// LINE *of code* I WANT COMMENTED 
// LINE *of code* I WANT COMMENTED 
// LINE *of code* I WANT COMMENTED

La plupart des IDE ont une seule commande clavier pour faire/annuler cela, il n'y a donc vraiment aucune raison d'utiliser l'autre style. Par exemple: dans Eclipse, sélectionnez le bloc de texte et appuyez sur Ctrl + /
Pour annuler ce type de commentaire, utilisez Ctrl + \

MISE À JOUR: La convention de codage Sun dit que ce style ne doit pas être utilisé pour les commentaires de bloc texte :

// Using the slash-slash
// style of comment as shown
// in this paragraph of non-code text is 
// against the coding convention.

mais // peut être utilisé de 3 autres façons:

  1. Un commentaire sur une seule ligne
  2. Un commentaire à la fin d'une ligne de code
  3. Commenter un bloc de code
12
JeffH
/*
 *STUFF HERE
 */

ou vous pouvez utiliser // sur chaque ligne.

Voici ce qu'on appelle un commentaire JavaDoc qui vous permet d'utiliser certaines balises (@return, @param, etc ...) à des fins de documentation.

   /**
    *COMMENTED OUT STUFF HERE
    *AND HERE
    */

Plus d'informations sur les commentaires et les conventions peuvent être trouvées ici .

11
CheesePls

Avec /**/:

/*
stuff to comment
*/
5
zellio

Vous pouvez utiliser/* commencer le commentaire et le terminer par * /

Ou vous pouvez simplement utiliser // sur chaque ligne (non recommandé)

/*
Here is an article you could of read that tells you all about how to comment
on multiple lines too!:

[http://Java.Sun.com/docs/codeconv/html/CodeConventions.doc4.html][1]
*/
4
JonH

  • La question simple de votre réponse a déjà été posée à maintes reprises:

    /*
LINES I WANT COMMENTED
LINES I WANT COMMENTED
LINES I WANT COMMENTED
*/

  • D'après votre question, il semble que vous souhaitiez commenter beaucoup de code ?? Je conseillerais d'utiliser un référentiel (git/github) pour gérer vos fichiers au lieu de commenter les lignes.

  • Mon dernier conseil serait d'en savoir plus sur javadoc s'il n'est pas déjà familier car la documentation de votre code est vraiment importante.
1
Alfred