Commentaires sur une seule ligne et commentaires sur plusieurs lignes en Java

En programmation, les commentaires sont un élément indispensable. D'une part, les commentaires permettent de voir clairement la structure du code et de le rendre plus facile à retrouver. D'autre part, ils sont également propices au transfert de travail entre collègues. Alors aujourd'hui, je vais vous parler des commentaires sur une seule ligne et des commentaires sur plusieurs lignes en Java. Les amis dans le besoin peuvent s'y référer, j'espère que cela vous sera utile.

Que sont les commentaires ? Un commentaire est un morceau de texte. Ce texte n'est pas nécessaire et ne participe pas directement au déroulement du code.

Les commentaires sont utilisés pour expliquer la fonction d'un certain morceau de code, ou le but d'une certaine classe, la fonction de chaque méthode, ainsi que les types de données et la signification des paramètres et des valeurs de retour de la méthode, etc.

Pourquoi ajouter des commentaires ?

1. Ne faites jamais trop confiance à votre propre compréhension. Afin de comprendre simplement et clairement votre code précédent au fil du temps, il est recommandé d’ajouter des commentaires.
2, la lisibilité d'abord, l'efficacité ensuite. Dans le développement collaboratif en équipe, la communication entre les membres de l'équipe est plus importante. Pour que le code que vous écrivez soit compris par toute l'équipe, il est recommandé d'ajouter des commentaires.
3. Le code est de la documentation. J'écris généralement du code Afin de générer des documents standardisés, il est recommandé d'ajouter des commentaires.

Dans le travail réel, j'entends souvent certains collègues dire que le code des autres n'a pas de commentaires. En fait, un code magnifiquement écrit ne nécessite pas trop de commentaires. Au contraire, je n'aime pas personnellement les commentaires qui remplissent. l'écran. Ou un code inutile est extrêmement répréhensible, surtout après avoir utilisé git, svn et d'autres outils de gestion de versions, je supprimerai tout le code commenté inutile.

Voici ma compréhension personnelle des annotations :

1. Les annotations nécessaires doivent être présentes. Par exemple, la signification des champs dans les Javabeans doit avoir des annotations pertinentes. Par exemple, certaines fonctions sont temporairement implémentées dans certains codages, mais certains domaines défectueux doivent être optimisés. J'écris généralement un TODO pour implémenter les fonctions de base, puis je reviens en arrière et je les améliore moi-même.
2. N'écrivez pas de commentaires idiots et inutiles, et ne conservez aucune ligne de code commentée. De nos jours, les codes sont généralement gérés par des outils de version, il n'y a donc pas lieu de s'inquiéter de la perte du code.
3. Respectez strictement les conventions de dénomination Java. Ne vous inquiétez pas des noms de variables trop longs, et ne vous inquiétez pas des noms de méthodes trop longs. Il est bien préférable d'écrire des commentaires chinois inutiles.

Les commentaires du programme constituent une partie importante du code source. Pour un code source de programme standardisé, les commentaires doivent représenter environ un tiers du code source.

Presque tous les langages de programmation fournissent la fonction de commentaire. Les langages de programmation généraux fournissent des commentaires de base sur une seule ligne et des commentaires sur plusieurs lignes, et Java ne fait pas exception. De plus, le langage Java fournit également un commentaire de documentation.

Ce blog triera d'abord les commentaires sur une seule ligne et les commentaires sur plusieurs lignes en Java Les commentaires de documentation sont généralement utilisés pour générer des API.

Commentaires sur une seule ligne et commentaires sur plusieurs lignes

Un commentaire sur une seule ligne consiste à commenter une ligne de code dans le programme. En langage Java, mettez le double. slash "//" si nécessaire. Il suffit de mettre le contenu de l'annotation avant.

Dans Eclipse, la touche de raccourci pour les commentaires sur une seule ligne est commande+/. Appuyez une fois pour ajouter un commentaire et appuyez une fois pour annuler le commentaire.

Les commentaires sur plusieurs lignes permettent de commenter plusieurs lignes de code dans le programme à la fois. En langage Java, utilisez "/*" et "*/" pour inclure le contenu qui doit être commenté dans le programme. , "/ *" indique le début d'un commentaire et "*/" indique la fin d'un commentaire.

Dans Eclipse, la touche de raccourci pour les commentaires multilignes est commande+contrôle+/. Vous devez sélectionner le code lorsque vous l'utilisez. J'utilise rarement les commentaires multilignes.

Publiez maintenant un morceau de code pour démontrer les commentaires sur une seule ligne et les commentaires sur plusieurs lignes en Java.

/**
 * Java的单行注释和多行注释.
 * 
 * @author LinkinPark
 */
public class Comment
{
 public static void main(String[] args)
 {
  // 这里是Java的单行注释
  System.out.println("演示Java的单行注释。。。");
  /*
   * 这里是Java的多行注释
   */
  System.out.println("演示Java的多行注释。。。");
 }
}

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!