Comment utiliser le raccourci de commentaire dans VS Code

En codage, les commentaires sont l’un des rares moyens de préserver les pensées pour l’avenir. Ils peuvent vous aider à passer sous silence des extraits de code et peuvent être utiles au prochain développeur qui tentera de comprendre ce que vous avez écrit quelques jours auparavant. Si vous utilisez Visual Studio Code (VS Code), il n’est pas nécessaire de taper inlassablement des délimiteurs de commentaires à chaque fois. VS Code dispose d’une fonction de raccourci intégrée qui vous fait gagner des secondes (et même des minutes) de votre temps.

Le raccourci de commentaire de code Quick VS

Pour les plus pressés, voici votre ticket d’or :

• Pour un commentaire sur une seule ligne, utilisez la combinaison de touches Ctrl + / sous Windows ou Linux ou Cmd + / sur Mac.
  ,
• Pour un commentaire de bloc, utilisez plutôt Shift + Alt + A sous Windows ou Linux ou Shift + Option + A sur Mac.
  ,
• Pour commenter le code, vous pouvez appuyer sur Ctrl + K + C sous Windows ou Cmd + K + U sur Mac.
  ,

La plupart des codeurs commentent beaucoup. Et il ne s’agit pas seulement de laisser de vrais commentaires, mais peut-être plus important encore, vous commenterez et décommenterez le code. Ceci est viable pour tester, expérimenter et déboguer.

Des raccourcis sont là pour rendre cela plus acceptable. Ils accélèrent la navigation et la modification, vous permettant de basculer entre les commentaires sans perturber la dynamique de codage.

Commenter au-delà des bases

Bien que les raccourcis de base soient un véritable cadeau, il y a bien plus à commenter VS Code. Approfondissons :

Basculer les commentaires

La meilleure partie des raccourcis de commentaires VS Code est leur fonction de bascule. Vous n’avez pas besoin de manipuler et de supprimer manuellement chaque marqueur de commentaire si vous changez d’avis (ou pendant le débogage). Au lieu de cela, vous utilisez simplement les mêmes raccourcis. Avec les mêmes combinaisons de touches, vous pouvez basculer rapidement entre le code commenté et non commenté pour rester organisé lorsque vous en avez le plus besoin.

Commenter plusieurs lignes

Si vous devez désactiver un long bloc de code ou laisser un commentaire détaillé et détaillé, vous ne voulez pas passer du temps à ajouter péniblement des commentaires ligne par ligne. Ainsi, à la place, vous pouvez sélectionner les lignes que vous souhaitez désactiver et utiliser le raccourci de commentaire pour laisser VS Code insérer des commentaires dans chaque ligne.

Commentaires imbriqués

Parfois, l’insertion de commentaires dans un bloc de code peut entraîner des résultats inattendus et des erreurs si les délimiteurs ne correspondent pas vraiment. C’est là qu’Intellisense de Visual Studio Code peut vous aider. Il ajustera le formatage des commentaires pour vous même dans un bloc déjà commenté, afin qu’il n’y ait pas de conflits avec les commentaires imbriqués.

Extensions aux commentaires Supercharge

VS Code est un éditeur open source servant de plate-forme permettant aux développeurs de publier leurs meilleurs travaux d’extension. Le marché regorge d’extensions pour vous offrir plus de puissance et d’utilité lorsque vous commentez :

De meilleurs commentaires

Les commentaires peuvent sembler être une partie petite et facultative du codage, mais il existe de nombreuses façons créatives d’utiliser les commentaires. Le De meilleurs commentaires L’extension vous aide à ajouter du sens et de la clarté aux commentaires que vous diffusez en les catégorisant en alertes, requêtes, TODO et autres catégories. Et tout cela avec en prime un code couleur pour une visibilité et une organisation améliorées. Vos commentaires deviennent des points de repère et des séparateurs qui rendent votre code plus clair et plus accessible.

Ancres de commentaires

Ancres de commentaires vous permet de rester ancré dans votre code avec des points précis qui distinguent les ps ou les endroits essentiels à l’intérieur. Si vous essayez cette extension, elle vous permettra de retrouver rapidement des notes et remarques précises. Si votre projet est vaste et que votre code devient chargé et difficile à suivre, cela pourrait le rendre beaucoup plus digeste.

Code Pola

Code Pola transforme votre code et vos commentaires en images visuellement intéressantes, facilement lisibles et partageables, parfaites pour les réseaux sociaux. Il vous permet de redimensionner, d’appliquer un code couleur, de modifier l’arrière-plan, etc. Vous bénéficiez d’une plus grande lisibilité et tous les coéquipiers peuvent collaborer et partager des informations beaucoup plus facilement.

Pourquoi commenter ?

Commenter n’est pas seulement une case à cocher ou une corvée facultative que font les personnes verbeuses ; cela fait partie intégrante du codage. Voici quelques-unes des raisons à cela :

Clarté

Les codeurs cherchent à rendre intelligible l’insoluble. Écrire du code qui fonctionne peut parfois être plus simple que d’écrire du code facile à comprendre et à suivre. Les commentaires sont la boussole du développeur – une aide inestimable pour naviguer dans des étendues de code, qu’elles soient légères et jeunes ou denses et matures. Vous avez peut-être affaire à des algorithmes alambiqués ou à des processus métier obscurs. Quoi qu’il en soit, les commentaires offrent une prise en main familière dans un océan de complexité.

Collaboration

Les commentaires sont pratiques lorsque vous êtes un développeur solo. Mais ils sont nécessaires lorsque l’on travaille en équipe si l’on souhaite que son projet avance. Dans le cadre d’un effort collaboratif, les commentaires permettent à plusieurs développeurs de travailler ensemble de manière transparente, même lorsqu’ils n’interagissent pas. Les membres de l’équipe peuvent expliquer le code et partager leurs processus de réflexion et les raisonnements qui sous-tendent leurs décisions. Cela sert de pont qui permet à chacun d’être sur la même longueur d’onde avec le projet et entre eux.

Débogage

Si vous revisitez un ancien code ou essayez de déboguer quelque chose qui vous mystifie, les commentaires deviennent votre grâce salvatrice. Ils conservent une trace de votre logique passée et de votre processus de réflexion qui peuvent vous indiquer une éventuelle logique erronée et vous ramener aux origines du bug. Avec ce rappel de votre situation passée, vous pouvez annuler les modifications problématiques, optimiser l’ancien code et vous remettre sur la bonne voie.

Conseils pour des commentaires efficaces

Vous savez maintenant comment utiliser les raccourcis de commentaires, disposer de quelques extensions supplémentaires pratiques et comprendre les scénarios dans lesquels les commentaires sont les plus utiles. Il ne vous reste plus qu’à considérer quelques bonnes pratiques en matière de commentaires et vous aurez terminé le cours de codage des commentaires.

Soyez concis

Il y a du talent à laisser des commentaires concis et faciles à digérer. Laissez-en juste assez pour donner à votre futur moi ou aux membres de votre équipe la bonne idée, mais pas trop pour être écrasant. Chaque mot de votre commentaire doit avoir un but et contribuer à développer le message que vous essayez de transmettre. Si votre commentaire est trop bref, il risque de ne pas transmettre son message, mais s’il est trop long, vous risquez davantage de le survoler ou d’être confus à l’avenir.

Évitez les commentaires évidents

La pertinence devrait être votre principale préoccupation dans la création d’un code clair et compréhensible. Si vous écrivez déjà votre code de manière à ce que sa signification soit évidente, inutile de mentionner quelque chose qui se voit au premier coup d’œil. Laissez le code parler chaque fois qu’il le peut et utilisez les commentaires pour ajouter un contexte supplémentaire ou offrir de nouvelles perspectives.

Utilisez les commentaires pour « Pourquoi » et non pour « Quoi »

Votre code expose les faits de ce qui se passe. Mais les commentaires peuvent raconter une histoire plus profonde. Ils transmettent les motivations et les processus de réflexion derrière vos décisions. Pourquoi avez-vous choisi cet algorithme plutôt qu’un autre ? Quels étaient les pièges à garder à l’esprit ? Peut-être avez-vous essayé un code que beaucoup recommanderaient, mais il n’a pas fonctionné ou ne fonctionnait pas bien. Vous pouvez transmettre bien plus que de simples instructions avec des commentaires bien rédigés.

Laisser un commentaire

La fonctionnalité de commentaires VS Code pourrait être plus qu’une commodité. Si vous en profitez pleinement, la différence dans la navigabilité et la compréhensibilité de votre base de code peut être énorme. Complété par des extensions intelligentes et une stratégie approfondie, vous pourrez bientôt créer un code bien documenté qui se lit comme un chef-d’œuvre.

Laissez-vous beaucoup de commentaires pour expliquer votre code ? Ou utilisez-vous principalement des commentaires pour exclure le code défectueux ou expérimental du débogueur ? Racontez-nous votre histoire dans les commentaires ci-dessous. Ils sont là pour rester.