Bonjour et bienvenue à nouveau.
Nous commençons une nouvelle section.
Et dans cette section, je veux parler de certains des concepts de base de C.
Je veux décrire certaines des choses que nous avons eues dans notre exemple ou notre premier défi,
notre programme principal ici.
Alors j'ai ce défi, vous vous en souvenez probablement.
Il a un certain nombre d'instructions différentes dans les lignes de code.
Je vais essayer de couvrir certains des concepts ici. Je vais aller et venir à cet exemple.
La première chose dont je veux discuter est le concept de commentaire.
Nous y reviendrons donc dans une seconde. Je veux passer à quelques diapositives à ce stade.
Les commentaires sont donc utilisés dans un programme pour documenter un programme
et améliorer sa lisibilité.
Je vous ai expliqué pourquoi il est important que votre programme soit lisible.
Parce que vous allez maintenir le code et que vous devez pouvoir l'examiner
et comprendre ce qu'il fait. Donc, avec des commentaires,
cela peut aider
un peu dans ce concept de lisibilité.
Les commentaires sont là pour vous rappeler à vous ou à quelqu'un d'autre qui
lit votre code ce que fait le programme ou ce que fait une ligne de code particulière.
Les commentaires sont donc là pour votre bénéfice.
Les commentaires sont ignorés par le compilateur.
Donc, peu importe si vous suivez la syntaxe des commentaires, le compilateur ne
lancera aucune erreur, quel que soit le contenu du commentaire.
Encore une fois, ils sont très utiles et vous souhaitez les utiliser dans vos programmes.
Et c'est un concept de base de tous les langages de programmation.
Et donc il n'y a vraiment rien de nouveau à voir ici.
Encore une fois, vous pouvez, en tant que programmeur, écrire du code, y revenir dans
6 mois et vous ne vous souvenez
peut-être pas pourquoi vous avez écrit le code comme vous l'avez fait.
Vous ne comprenez peut-être pas la fonctionnalité, vous ne comprenez peut-être pas la logique.
En fournissant un commentaire dans le code,
cela peut vous faire gagner un temps considérable que vous perdez à réapprendre des choses,
en particulier à réapprendre ce code.
Ou imaginez que vous avez écrit
du code et que c'est un gros programme, de nombreux programmeurs y travaillent et
que quelqu'un d'autre a besoin de regarder ce code.
S'il y a des commentaires et qu'ils décrivent ce que fait le code, alors
cette autre personne sera en mesure de comprendre ce code beaucoup plus rapidement.
Ça va être plus lisible. Encore une fois, les commentaires aident à la
lisibilité, soit ils aident la lisibilité du programmeur qui a écrit le code, soit
ils aident à la lisibilité de quelqu'un d'autre qui regarde le code.
Vous pouvez facilement consulter ce code source, puis comprendre rapidement ce que fait le code.
Et vous souhaitez donc fournir des commentaires dans votre code.
La syntaxe pour fournir des commentaires dans votre code est
qu'il existe deux façons de fournir des commentaires dans votre code.
Et encore une fois, c'est très, très similaire à java, très similaire à de nombreuses langues.
Mais en c, vous pouvez avoir des commentaires sur plusieurs lignes ou des commentaires uniques.
Si vous utilisez 2 caractères la barre oblique suivie de l'astérisque,
cela signifie un commentaire sur plusieurs lignes, un commentaire
qui s'étend sur plusieurs lignes.
Et l'étoile barre oblique marque le début de ce commentaire.
Et quand vous avez ces commentaires sur plusieurs lignes parce qu'ils ont un commentaire de départ,
vous devez avoir quelque chose qui dit que ça se termine.
Donc, pour terminer les commentaires, vous mettez les caractères astérisque barre oblique
à la fin sans aucun espace entre les deux.
Et donc, tout ce qui se trouve entre l'étoile
barre oblique avant et l'étoile barre oblique finale
est considéré comme un
commentaire, tout en bleu. Et de cette façon, vous pouvez couvrir plusieurs lignes.
L'autre façon que vous pouvez ajouter un commentaire à votre programme c est que vous pouvez utiliser des
commentaires sur une seule ligne.
Les commentaires sur une seule ligne ne sont que 2 barres obliques.
Tout ce qui se trouve après les 2 barres obliques sur cette ligne
est ignoré par le compilateur et considéré comme un commentaire.
Tout ce qui suit n'est pas un commentaire, c'est une nouvelle ligne de code.
Cela dépend donc vraiment du commentaire
que vous fournissez, que vous souhaitiez ou non utiliser des commentaires sur plusieurs lignes ou des commentaires sur une seule ligne.
Et je vais vous montrer comment vous pouvez les ajouter à votre code en une seconde.
Maintenant, en ce qui concerne le style, que vous utilisiez des commentaires sur plusieurs lignes ou des commentaires
sur une seule ligne, vous allez probablement utiliser les deux en fonction de ce que vous essayez de
faire, du nombre de lignes à décrire ou de la taille de votre commentaire.
Dans cet exemple, nous utilisons un commentaire sur plusieurs lignes ici, et cela
ira généralement en haut du fichier. Il décrit qui a
écrit le fichier, l'auteur du fichier, puis un droit d'auteur.
Vous pouvez également fournir des commentaires qui se démarquent si quelque
chose de vraiment, vraiment important dans votre code se produit
en fournissant de nombreux astérisques.
Et donc le deuxième exemple ici où il est dit que c'est un commentaire très important,
il se démarque vraiment à cause de tous ces astérisques.
C'est donc un style différent du commentaire d'en-tête en haut
du premier exemple.
Maintenant, le dernier exemple ici qui n'est qu'un commentaire sur une seule ligne, il
se trouve à la fin d'une ligne de code et il vous indique simplement ce que fait une seule ligne.
Vous voyez donc ces différents styles de commentaires sur plusieurs lignes et sur une seule ligne.
Voici un exemple courant que vous verriez dans un programme.
C'est un programme qui contient du code C.
Vous ne savez probablement pas vraiment ce que ça fait.
Mais vous pouvez regarder les commentaires et identifier en quelque sorte ce qui se passe.
Il y a donc un commentaire en haut qui dit que ce programme ajoute 2 valeurs entières et affiche les résultats.
Il vous indique le but du programme,
ce qu'il fait.
Et puis vous voyez quelques commentaires sur une seule ligne.
Et comment savez-vous que ce sont des commentaires sur une seule ligne? Parce qu'ils ont 2 barres obliques.
Vous voyez donc un commentaire sur une seule ligne indiquant la déclaration des variables.
Vous en voyez un autre qui dit attribuer des valeurs et calculer leur somme.
Et puis vous en voyez un qui dit afficher le résultat.
Chaque commentaire sur une seule ligne décrit chaque groupe de code, vous indiquant ce
qu'ils font.
Et ainsi vous pouvez rapidement regarder
ce code et comprendre ce que fait le code en regardant les commentaires.
Cela rend le programme plus lisible.
La lisibilité est un avantage car elle facilite la maintenance du code.
Il est donc important d'utiliser des commentaires. Et ceci est un exemple rapide d'ajout
de commentaires à un code.
Maintenant, à quelle fréquence devons-nous utiliser les commentaires.
Il y a le concept d'avoir trop de commentaires.
Vous ne voulez pas que votre code contienne un commentaire pour chaque ligne.
Cela diminue en fait la lisibilité du code car il déborde.
En fait, cela rend la lecture plus difficile parce que c'est tout simplement écrasant.
Vous ne voulez donc pas mettre de commentaire pour chaque ligne de code.
Vous devez choisir vos commentaires judicieusement et les utiliser intelligemment.
Cela viendra avec la pratique, quand ajouter des commentaires,
quand ne pas ajouter de commentaires, où mettre les commentaires.
En règle générale, j'aurai des commentaires en haut de mon
fichier source avec une information standard comme l'auteur, le but, la description, la
date de création des commentaires, puis entrecoupés tout au long de mon code, décrivant
certaines lignes de code où la logique est un peu plus compliqué.
Je n'inclurai pas toujours de commentaires pour simplement déclarer des variables parce que c'est assez évident.
Je ne peux pas inclure de commentaires pour certaines fonctions, des
descriptions parce que la description elle-même pourrait être plus significative.
Tout dépend et cela vient avec la pratique.
Mais chaque fois que vous ajoutez des commentaires, il est généralement judicieux d'ajouter
ces commentaires lorsque vous écrivez le code.
Premièrement, si vous le faites alors, vous aurez le programme commenté et vous
n'oublierez pas de le faire.
Il est également plus facile de documenter le programme pourquoi
vous comprenez réellement ce qu'il fait pendant que vous écrivez le code.
Toujours frais dans votre esprit, vous n'avez pas besoin de revenir un mois plus
tard et de dire ce que je voulais dire ici et maintenant je dois ajouter un commentaire.
Alors ajoutez les commentaires pendant que vous écrivez le code.
Et les commentaires peuvent également vous aider lorsque vous essayez de trouver et de corriger vos
erreurs, pendant la phase de débogage. S'il y a des erreurs de logique,
vous pouvez regarder les commentaires et vous pouvez en quelque sorte isoler, eh
bien, c'est l'erreur qui s'est produite.
Ce commentaire correspond en quelque sorte à cette fonctionnalité.
Je vous parie que l'erreur se trouve dans ce groupe de code. Cela vous aide donc à isoler les erreurs de débogage.
Un commentaire peut vous aider à lire le programme, mais il peut également indiquer la
source d'une erreur de logique, les commentaires sont donc importants.
Maintenant, l'autre argument lorsque vous fournissez des commentaires est
qu'il y a à nouveau ce grand débat avec les programmeurs, combien de commentaires fournissez-vous?
Et il y a un joli livre appelé Clean Code, qui parle
d'écrire du code de qualité. Croyez-le ou non, il
peut y avoir du bon ou du mauvais code, et c'est
ce qu'on appelle la qualité du code.
Vous voulez écrire du code de haute qualité.
Nous en parlerons tout au long du cours, mais beaucoup d'étudiants qui apprennent de nouvelles langues pensent que tant que
le résultat correspond à ce dont j'ai besoin, peu
importe comment j'écris le code. Ce n'est pas vrai.
Car encore une fois, souvenez-vous de cette phase de maintenance.
N'oubliez pas que le produit ou
le programme que vous lancez sera sur le terrain peut-être pendant un certain nombre d'années.
Et donc, si vous voulez trouver des bogues existants ou ajouter de nouvelles fonctionnalités, il
est important que le code soit de très haute qualité, plus facile à maintenir,
très faiblement couplé, hautement cohérent.
Et nous parlerons de ces concepts au fur et à mesure.
Nous allons écrire du code de haute qualité tout au long de la classe.
L'un des moyens d'écrire du code de haute qualité consiste à fournir des commentaires, mais
également à fournir des commentaires auto-documentés.
Cela signifie vraiment utiliser des noms significatifs. C'est ce dont parle ce livre Clean Code.
Lorsque vous créez une variable, utilisez un nom significatif.
Ainsi, lorsque vous regardez la variable, vous savez exactement à quoi elle sert, alors vous
n'avez pas besoin de fournir de commentaire.
Si vous avez une fonction qui ajoute 2 nombres, nommez la fonction ajoutez 2 nombres.
Avez-vous alors besoin d'un commentaire pour dire ce que fait cette fonction, non.
Parce que le nom vous dit ce qu'il fait.
Les noms significatifs sont donc un bon moyen de fournir des commentaires auto-documentés.
Revenons à notre exemple de notre défi et
je veux vous montrer exactement comment vous
pouvez ajouter des commentaires et où vous les ajoutez.
Et vous remarquerez que le compilateur va ignorer ces commentaires.
Donc, dans notre premier exemple ici qui est un programme
de base, j'ajouterai généralement des commentaires sur plusieurs lignes en haut du fichier avant toute ligne de code.
Et rappelez-vous que nous pouvons ajouter ces commentaires sur plusieurs lignes en fournissant simplement une barre oblique, une
étoile, un astérisque pour commencer le commentaire.
Et puis tout ce qui se trouve entre
le commentaire sera le
commentaire, tout ce qui se trouve entre l'étoile et l'astérisque.
Et vous remarquerez quand je fais cette étoile slash que tout est gris parce que
cela me dit que je n'ai pas mon commentaire de fin pour le moment.
Vous devez donc ajouter cette barre oblique
en étoile pour terminer le commentaire. Et vous verrez que les couleurs changent maintenant.
C'est pourquoi j'aime utiliser un IDE car il vous en dit beaucoup avec ce formatage coordonné
par couleur.
Ainsi, tout ce qui se trouve entre l'étoile barre oblique est le début
d'un commentaire sur plusieurs lignes, tout ce qui se trouve avant l'étoile en avant est
la description ou la fin du commentaire sur plusieurs lignes.
Et je mettrai généralement en haut du fichier quelque
chose comme auteur et je mettrai mon nom et ensuite je mettrai peut-être un but.
C'est généralement une bonne pratique et je vais mettre quelque chose
comme ce programme, imprime mon nom à l'écran.
Et puis je vais généralement fournir une date de création quelle que soit la date.
Et c'est un exemple de haut de commentaire sur plusieurs lignes. Et puis je fournirai des commentaires tout
au long du code. Généralement des commentaires sur une seule
ligne ou des commentaires sur plusieurs lignes, cela dépend juste du nombre de commentaires.
Alors peut-être que nous ne sommes pas familiers avec ce code. Et je pourrais dire que vous savez que
2 barres obliques sont un commentaire sur une seule ligne. Je peux dire que ce
code affiche mon nom.
Et encore une fois, lorsque je fournis ces barres obliques ou ces commentaires
sur plusieurs lignes, le compilateur les ignore. En gros, vous pouvez y mettre tout ce que vous voulez et cela n'a pas d'importance.
Il n'y a pas de syntaxe à suivre, il n'y a rien.
C'est ignorer tout ce qui est de couleur grise ici, qui est
considéré comme un commentaire.
Les commentaires sont donc un élément fondamental de chaque programme.
Je voulais les décrire très tôt car je les utiliserai et vous devriez les ajouter
au fur et à mesure que vous écrivez votre code.
De plus, avec des commentaires dans l'EDI,
il y a des moments où vous compilez votre code et tout échoue.
Et donc il y a des moments où vous voudrez peut-être tout commenter ou
commenter des blocs de code pour essayer de déboguer votre problème, essayez d'isoler votre erreur.
Vous pouvez mettre en évidence plusieurs lignes de code,
puis vous montez à l'édition dans le menu et vous pouvez
dire commenter ou décommenter.
Si vous dites commenter, cela va commenter tout ce code que vous
avez mis en évidence.
Et puis vous pouvez recompiler et peut-être que vous n'avez plus d'erreur de compilation.
C'est un moyen d'isoler les erreurs au moment de l'exécution ou de la compilation.
L'EDI dispose donc de bons outils qui
vous permettent de commenter automatiquement plusieurs lignes en les mettant en surbrillance et
en les basculant.