Guide des commentaires Python 3

Dans Python 3, les commentaires sont des annotations textuelles qui ne sont pas exécutées par l’interpréteur Python. Ils sont utilisés pour documenter le code, expliquer son fonctionnement, ajouter des notes pour les développeurs ou désactiver temporairement des parties du code. Voici plusieurs façons de rédiger des commentaires en Python 3 :

Commentaires sur une seule ligne :
Pour écrire un commentaire sur une seule ligne, vous pouvez utiliser le symbole dièse (#). Tout ce qui suit le dièse sur la même ligne est ignoré par l’interpréteur Python.

Exemple :
```
python
# Ceci est un commentaire sur une seule ligne
x = 5  # Vous pouvez également placer le commentaire à la fin d'une ligne de code
```
Commentaires sur plusieurs lignes :
Si vous avez besoin de rédiger un commentaire sur plusieurs lignes, vous pouvez utiliser des triples guillemets simples (''') ou doubles ("""). Bien que ces chaînes de documentation multi-lignes soient principalement utilisées pour la documentation des fonctions et des modules, elles peuvent également être utilisées comme commentaires sur plusieurs lignes.

Exemple :
```
python
'''
Ceci est un commentaire sur
plusieurs lignes en utilisant
des triples guillemets simples.
'''

"""
Ceci est un autre exemple de commentaire
sur plusieurs lignes en utilisant
des triples guillemets doubles.
"""
```
Commentaires de documentation :
Pour documenter des fonctions, des classes ou des modules de manière plus formelle, vous pouvez utiliser des docstrings. Les docstrings sont des chaînes de caractères placées au début d’une fonction, d’une classe ou d’un module. Ils sont généralement utilisés pour fournir une documentation sur le but, les paramètres et la valeur de retour d’une fonction, ainsi que d’autres informations pertinentes.

Exemple :
```
python
def addition(a, b):
    """
    Cette fonction prend deux nombres en entrée
    et retourne leur somme.
    
    Args:
        a (int): Le premier nombre.
        b (int): Le deuxième nombre.
    
    Returns:
        int: La somme des deux nombres.
    """
    return a + b
```
Commentaires pour désactiver du code :
Parfois, vous pouvez vouloir temporairement désactiver une partie du code sans la supprimer complètement. Dans ce cas, vous pouvez utiliser des commentaires.

Exemple :
```
python
'''
if condition:
    code_à_désactiver
'''

# code_à_désactiver
```

En suivant ces méthodes, vous pouvez facilement intégrer des commentaires dans votre code Python 3 pour le rendre plus lisible, plus compréhensible et plus facile à maintenir.

Plus de connaissances

Bien sûr, explorons davantage les commentaires en Python 3 :

Utilisation des commentaires :
Les commentaires sont un aspect essentiel de la programmation. Ils permettent aux développeurs de comprendre le code, d’expliquer la logique derrière les décisions de conception, et de faciliter la collaboration au sein d’une équipe de développement. Les commentaires bien rédigés peuvent rendre le code plus facile à lire, à maintenir et à déboguer.
Conventions de commentaires :
Bien qu’il n’existe pas de norme stricte pour rédiger des commentaires en Python, il est recommandé de suivre certaines conventions pour garantir la cohérence et la lisibilité du code. Par exemple :
- Utilisez des commentaires pour expliquer le « pourquoi » plutôt que le « comment » (le « comment » devrait être évident dans le code lui-même).
- Évitez les commentaires évidents ou redondants qui ne fournissent pas de valeur supplémentaire.
- Maintenez une longueur de

commentaire raisonnable ; évitez les commentaires trop longs qui pourraient rendre le code difficile à lire.

Utilisez des phrases complètes et une orthographe correcte pour rendre les commentaires clairs et professionnels.
Mettez à jour les commentaires lorsque le code change pour éviter toute divergence entre le code et sa documentation.

Docstrings :
Les docstrings sont des chaînes de documentation utilisées pour documenter des fonctions, des classes et des modules Python. Elles sont placées juste après la déclaration de la fonction, de la classe ou du module, entre triples guillemets simples (''') ou doubles ("""). Les docstrings peuvent être consultées via la fonction help() ou en accédant à l’attribut __doc__ de l’objet concerné.
Commentaires conditionnels :
Les commentaires peuvent également être utilisés pour désactiver temporairement du code en cours de développement ou pour inclure des alternatives conditionnelles. Cependant, il est important de ne pas laisser de code inutilisé ou de commentaires obsolètes dans le code final.
Révision de code :
Les commentaires peuvent également jouer un rôle crucial dans le processus de révision de code. Les développeurs peuvent ajouter des commentaires pour expliquer leurs choix de conception, signaler des points de discussion ou des préoccupations, et suggérer des améliorations.

En intégrant judicieusement des commentaires dans votre code Python 3, vous pouvez améliorer sa lisibilité, sa maintenabilité et sa qualité globale. Cependant, il est essentiel de trouver le bon équilibre, en fournissant des explications suffisantes sans surcharger le code de commentaires superflus.