Conventions

Conventions Pharo/Seaside

Nommage

• Les noms de classes commencent par une majuscule
• Les noms de méthodes commencent par une minuscule
• Les noms de méthodes sont en camlCase
• Les noms de méthodes permettant d'afficher des bouts de composants en Seaside sont sous la forme: #renderXXXon:
• Les variables contenants un canvas HTML en Seaside s'appellent html
• Les variables d'instances et les variables d'instances de classes commencent par une minuscule et sont et camlCase
• Les variables de classes commencent par une majuscule

Protocole

En Pharo nous avons la possibilité de trier les méthodes en protocoles. Voici quelques protocoles communs:

• accessing: contient tous les getteurs et setteurs
• testing: contient toutes les méthodes qui vont tester quelque chose et renvoyer un booleen.
• instance creation: protocole utilisé côté classe qui contient les méthodes renvoyant de nouvelles instances de la classe.
• initialization: contient les méthodes qui permettent d'initialiser un objet
• comparing: contient des méthodes de comparaisons tel que #<, #>, #=, #hash…
• rendering: contient les méthodes d'affichage de composants Seaside
• error handling: contient les méthodes qui gèrent les erreurs
• tests: dans une classe de test, contient les méthodes de pur test
• convenience: contient les méthodes de convenance d'un objet
• private: contient les méthodes qui ne devraient pas être appelées. Elles sont susceptibles d'être supprimées plus tard lors d'un nettoyage du code.
• …

Autre

• L'initialisation d'un objet se fait dans une méthode appelée #initialize

Conventions d'équipe