Les meilleures pratiques en XML

Guillaume LELEU

Mis en ligne le 21-08-2023 à 11:44

Langues disponibles

1 . Quelques pratiques à éviter

## Structuration Hiérarchique et Éléments Descriptifs

Dans cet exemple, la mauvaise pratique utilise des éléments abrégés (noms cryptiques comme "n", "s", "a") pour représenter des informations sur une personne. Cela peut rendre difficile la compréhension du contenu du document. La bonne pratique utilise des noms d'éléments descriptifs (comme "first-name", "last-name", "age") qui rendent clair ce que chaque élément représente.

**Mauvaise pratique :**
``` 
  <person>
    <n>John</n>
    <s>Smith</s>
    <a>30</a>
</person>
```

**Bonne pratique :**
``` 
  <person>
    <first-name>John</first-name>
    <last-name>Smith</last-name>
    <age>30</age>
</person>

```

## Utilisation des Éléments Vides et des Attributs

La mauvaise pratique utilise des attributs pour stocker l'état des tâches, ce qui peut entraîner la duplication d'informations. La bonne pratique utilise des éléments vides pour représenter des tâches sans avoir besoin d'utiliser des attributs.

**Mauvaise pratique :**
``` 
<task status="completed">Fix bugs</task>
<task status="in-progress"></task>

```

**Bonne pratique :**
``` 
<task status="completed">Fix bugs</task>
<task status="in-progress"/>

```

## Commentaires et Documentation

La mauvaise pratique manque de commentaires pour expliquer le contenu du document. La bonne pratique utilise un commentaire pour indiquer que des informations spécifiques au client sont incluses.

**Mauvaise pratique :**
``` 
  <customer name="John Doe">
    
    <email>johndoe@example.com</email>
</customer>

```

**Bonne pratique :**
``` 
  <customer name="John Doe">
    
    <email>johndoe@example.com</email>
</customer>

```

## Utilisation d'une Structure Arborescente Claire

La mauvaise pratique combine différents types de données (produits et commandes) sous le même élément parent "data". La bonne pratique organise les données de manière plus cohérente en les plaçant sous des éléments parent distincts ("store", "products", "orders").

**Mauvaise pratique :**
``` 
  <data>
    <product>
        <name>Product 1</name>
        <price>100</price>
    </product>
    <order>
        <name>Order 1</name>
        <total>200</total>
    </order>
</data>

```

**Bonne pratique :**
``` 
  <store>
    <products>
        <product>
            <name>Product 1</name>
            <price>100</price>
        </product>
    </products>
    <orders>
        <order>
            <name>Order 1</name>
            <total>200</total>
        </order>
    </orders>
</store>

```

## Éviter les Données Redondantes

La mauvaise pratique stocke le nom de l'école à l'intérieur de chaque étudiant, ce qui peut conduire à des incohérences si le nom de l'école change. La bonne pratique extrait les informations sur l'école en tant qu'élément distinct ("school") pour éviter la duplication.

**Mauvaise pratique :**
``` 
  <student>
    <name>John</name>
    <age>20</age>
    <school>School A</school>
</student>

```

**Bonne pratique :**
``` 
  <student>
    <name>John</name>
    <age>20</age>
    <school>
        <name>School A</name>
        <location>City X</location>
    </school>
</student>

```

## Utilisation de Valeurs Normalisées

La mauvaise pratique utilise des attributs numériques pour stocker les codes d'état des tâches. La bonne pratique utilise des éléments pour stocker les états des tâches en tant que texte clair, ce qui les rend plus lisibles et compréhensibles.

**Mauvaise pratique :**
``` 
  <status code="1">Pending</status>
<status code="2">In Progress</status>
<status code="3">Completed</status>

```

**Bonne pratique :**
``` 
  <status>Pending</status>
<status>In Progress</status>
<status>Completed</status>

```

En appliquant ces explications et en suivant ces exemples de bonnes pratiques, vous pouvez structurer vos documents XML de manière plus cohérente, lisible et maintenable. Cela rendra vos données plus faciles à gérer et à interpréter, tant pour vous que pour d'autres développeurs qui pourraient travailler avec vos documents XML.

Les meilleures pratiques en XML

1 . Quelques pratiques à éviter

Sommaire