Style de programmation

Le manuel de aRts
Précédent | Chapitre 11. Contribuer à aRts | Suivant

# 11.3. Style de programmation

Pour obtenir un code source homogène, il est important de garder un style de programmation dans tous les sources de aRts. Même si vous écrivez simplement un module, essayez d'écrire et formater votre source en conséquence, de façon à faciliter le travail de différentes personnes dans la gestion des sources, et faciliter la copie de morceaux de codes d'un source vers un autre.

Nom des fonctions membres

  Style Qt/Java, ce qui signifie une majuscule au début de chaque mot, et la première lettre toujours en minuscule ; aucun caractère de soulignement.

  Voici un exemple

         1    createStructureDesc()
         2    updateWidget();
         3    start();

Membres de classes

  Les membres de classes s'écrivent en minuscule, comme par exemple menubar ou button.

  Lorsqu'il y a des fonctions d'accès, le standard devrait être celui de MCOP, c'est-à-dire lorsque vous avez un membre foo de type long, qui ne doit pas être visible directement, vous créez les fonctions

         1    foo(long new_value);
         2    long foo();

  pour récupérer et envoyer les valeurs. Dans ce cas, la valeur réelle de foo devrait être stockée dans _Foo.

Nom des classes

  Toutes les classes doivent s'écrire avec une majuscule au début de chaque mot, par exemple ModuleView, SynthModule. Les classes qui appartiennent aux librairies doivent utiliser les espaces de noms de Arts, comme Arts::Soundserver.

  Les implantations des classes MCOP doivent être appelées Class_impl, comme par exemple SoundServer_impl.

Paramètres

  Les paramètres sont toujours en minuscule.

Variables locales

  Les variables locales sont toujours en minuscule, et ont des noms comme i, p, x, etc.

Largeur de tabulation (largeur du décalage)

  Une tabulation correspond à 4 espaces.

Noms des fichiers sources

  Les fichiers sources sont en minuscule. Ils doivent porter le nom de la classe lorsqu'ils implantent une classe unique. Leur extension est .cc s'ils contiennent du code indépendant de Qt/GUI, et .cpp s'ils contiennent du code dépendant de Qt/GUI. Les fichiers d'implantation pour les interfaces doivent être appelés `foo`_impl, si Foo est le nom de l'interface.

  Les fichiers IDL doivent être appelés de manière descriptive pour l'ensemble des interfaces qu'ils contiennent, aussi tout en minuscule. En particulier, il est déconseillé de donner à un fichier idl le nom de la classe elle même, car le sélecteur de fichiers .mcopclass (.mcopclass trader) et les informations de type entreront en conflit.

Précédent | Sommaire | Suivant
Listes de discussion | Niveau supérieur | Travaux futurs