Aller au contenu

Écrire du code⚓︎

Les backticks

Pour mettre du texte en mode code, on utilise des backticks (ou accents graves) avant et après le texte.

OĂą les trouver ?

On y accède par les touches Alt Gr + è du clavier Windows, et en accès direct sur un clavier mac.

Code en ligne⚓︎

Sans coloration syntaxique⚓︎

On peut placer tout contenu en mode code, sans faire référence à un langage de programmation.

Sans coloration syntaxique

La variable `nombres` est de type `list` et la valeur référencée est `[1, 2, 3]`

La variable nombres est de type list et la valeur référencée est [1, 2, 3]

Avec coloration syntaxique⚓︎

Si l'on précise un langage de programmation, la coloration syntaxique s'applique.
La syntaxe est `#!short_name_langage` où short_name_langage est le nom court associé au langage.

Avec coloration syntaxique

La variable `nombres` est de type `#!py list` et la valeur référencée est `#!py [1, 2, 3]`

La variable nombres est de type list et la valeur référencée est [1, 2, 3] 

Le contenu est entre les balises `#!html <body>` et `#!html </body>`

Le contenu est entre les balises <body> et </body>

Remarques

  • Il faut aussi penser Ă  rajouter un backtick (ouvrant et fermant) si le code Ă  mettre en Ă©vidence en contient lui-mĂŞme.
    Ici pour Ă©crire `#!short_name_langage ...`, on a dĂ» Ă©crire :
    ``#!markdown `#!short_name_langage` ``

Bloc de code⚓︎

On crée un bloc de code en utilisant trois backticks ouvrants et trois backticks fermants. On peut faire suivre les backticks ouvrants du nom du langage pour activer la coloration syntaxique.

Sans coloration syntaxique⚓︎

Sans coloration

```
compteur prend la valeur 0
pour nombre allant de 1 Ă  10
    ajouter nombre Ă  compteur
```

compteur prend la valeur 0
pour nombre allant de 1 Ă  10
    ajouter nombre Ă  compteur

Avec coloration syntaxique⚓︎

Dans une console Python

```pycon
>>> nombres = [3, 8, 7]
>>> fruits = ['Poire', 'Pomme', 'Orange', 'Kiwi']
```

>>> nombres = [3, 8, 7]
>>> fruits = ['Poire', 'Pomme', 'Orange', 'Kiwi']

Dans un Ă©diteur Python

```python
print("Hello World")
```

print("Hello World")

Bloc de code avec titre⚓︎

Dans un Ă©diteur Python

```python title="Bloc de code avec titre"
print("Hello World!")
```
Bloc de code avec titre
print("Hello World!")

Numérotation des lignes⚓︎

On peut afficher des numéros de ligne, en ajoutant linenums='1' :

Dans un éditeur Python avec numéros de lignes

```python linenums='1'
a = 1
b = 2
t = b
b = a
a = t
```

1
2
3
4
5
a = 1
b = 2
t = b
b = a
a = t

Annotation du code⚓︎

Les annotations de code sont positionnées dans un commentaire du langage concerné par le bloc de code. Elles apparaissent sous la forme d'un +, qui affiche un message au clic.

Annotations - première présentation

Attention

Bien veiller à mettre une ligne vide après la balise fermante ``` et avant les annotations numérotées.

```python 
note = 15
if note >= 16:  # (1)
    print("TB")
elif note >= 14:  # (2)
    print("B")
elif note >= 12:  # (3)
    print("AB")
elif note >= 10:
    print("reçu")
else:
    print("refusé")
```

1. :warning: Le caractère `#!py :` est **obligatoire** après `if`, `elif`, `else`, `for` et `while`. Il provoque l'indentation automatique du bloc d'instruction qui suit.

2. :warning: `elif` signifie **sinon si**.

3. :warning: Le caractère `#!py :` est **obligatoire** après `if`, `elif`, `else`, `for` et `while`. Il provoque l'indentation automatique du bloc d'instruction qui suit.

!!! warning "Prenez le temps de lire les commentaires (cliquez sur les +)"

note = 15
if note >= 16:  # (1)
    print("TB")
elif note >= 14:  # (2)
    print("B")
elif note >= 12:  # (3)
    print("AB")
elif note >= 10:
    print("reçu")
else:
    print("refusé")

  1. ⚠ Le caractère : est obligatoire après if, elif, else, for et while. Il provoque l'indentation automatique du bloc d'instruction qui suit.

  2. âš  elif signifie sinon si.

  3. ⚠ Le caractère : est obligatoire après if, elif, else, for et while. Il provoque l'indentation automatique du bloc d'instruction qui suit.

Prenez le temps de lire les commentaires (cliquez sur les +)

Annotations - deuxième présentation

!!! warning inline end "Important"

    Prenez le temps de lire les commentaires !

    Cliquez sur les +


```python
    note = 15
    if note >= 16:  # (1)
        print("TB")
    elif note >= 14:  # (2)
        print("B")
    elif note >= 12:  # (3)
        print("AB")
    elif note >= 10:
        print("reçu")
    else:
        print("refusé")
```

1. :warning: Le caractère `#!py :` est **obligatoire** après `if`, `elif`, `else`, `for` et `while`. Il provoque l'indentation automatique du bloc d'instruction qui suit.

2. :warning: `elif` signifie **sinon si**.

3. :warning: Le caractère `#!py :` est **obligatoire** après `if`, `elif`, `else`, `for` et `while`. Il provoque l'indentation automatique du bloc d'instruction qui suit.

Important

Prenez le temps de lire les commentaires !

Cliquez sur les +

    note = 15
    if note >= 16:  # (1)
        print("TB")
    elif note >= 14:  # (2)
        print("B")
    elif note >= 12:  # (3)
        print("AB")
    elif note >= 10:
        print("reçu")
    else:
        print("refusé")

  1. ⚠ Le caractère : est obligatoire après if, elif, else, for et while. Il provoque l'indentation automatique du bloc d'instruction qui suit.

  2. âš  elif signifie sinon si.

  3. ⚠ Le caractère : est obligatoire après if, elif, else, for et while. Il provoque l'indentation automatique du bloc d'instruction qui suit.

Lignes de code surlignées⚓︎

On peut également surligner des lignes, consécutives ou non, en couleur.

Surlignage de lignes de code

```python hl_lines="3 5-6"
def maximum_tab(tableau):
    assert tableau != [], "le tableau est vide"
    maximum = tableau[0]
    for valeur in tableau:
        if valeur > maximum:
            maximum = valeur
    return maximum
```

def maximum_tab(tableau):
    assert tableau != [], "le tableau est vide"
    maximum = tableau[0]
    for valeur in tableau:
        if valeur > maximum:
            maximum = valeur
    return maximum