Conventions de codage

Cette page présente les conventions de codage qui s’appliquent au code source de GCstar. Vous devriez les respecter lorsque vous modifiez le code ou lorsque vous créez de nouveaux plugins. Vous avez peut-être l’habitude d’appliquer d’autres conventions, mais aucune n’est parfaite, et définir et utiliser les mêmes conventions pour un projet facilite le travail des développeurs lors de la maintenance et l’évolution du code source de l’application.

Indentez toujours votre code en utilisant des espaces (code ASCII 32) et non des tabulations. Chaque niveau d’indentation doit comporter quatre espaces.

Pour chaque fonctions, boucles ou bloc, la parenthèse ouvrante doit être placée seule sur une ligne, au même niveau d’indentation que la ligne précédente. La parenthèse fermante doit être alignée verticalement avec la parenthèse ouvrante. Voici un exemple :

sub myMethod
{
    # Un peu de code ici
    while ($uneCondition)
    {
        # code de la boucle
    }
    if ($uneAutreCondition)
    {
        # code du if
    }
    else
    {
        # code du else
    }
}

Vous pouvez remarquer que le mot clef else doit aussi être seul sur sa ligne.

Tout le code doit être écrit en mode strict. Par conséquent tous les fichiers Perl, y compris les plugins, doivent débuter par cette ligne :

use strict;