Notre fiche récapitulative de bonnes pratiques ios

BONNES PRATIQUES CODE IOS
REGLES D’OR
LISIBILITE GENERALE
• Respecter les standards de l’équipe de dév (format, pratiques)
• Pas de code mort / commenté
• Ecrire le code le plus simple à comprendre et à maintenir (KISS)
• Pas de magic number / string à constantes
• Pas de duplication de code à mutualisation
NOMENCLATURE
• Aérer le code, créer des variables intermédiaires
• Pas d’abréviation
• Formater les sources (CodeFormatter)
• Donner aux variables des noms spécifiques typés
searchButton
arrivalTextField
(UIButton)
(UITextField)
• Nommer les vues dans les xib
• Séparer les imports par type
• Nommer les booleans avec un verbe d’état / descriptif
isOpened, shouldOpen, hasReceivedAnswer
• Donner un verbe et un complément aux noms de méthodes
- (void)clearCurrentSearch;
- (void)updateSearchButtonState;
• Standardiser les pratiques
o IBActions :
- (void)onSearchButtonClick:(id)sender;
o Pointeurs vides :
Utiliser nil (pas NULL)
o Booleans :
Utiliser YES / NO (pas true / false)
o Constantes :
Utiliser des static const (pas des #define)
COMMENTAIRES
• Documenter :
o les en-têtes de classes,
o les méthodes complexes,
o les constantes métier
• Commenter les blocs de code / extraire des
méthodes
• Utiliser les pragmas dans cet ordre :
o Getters & Setters
o Birth & Death
o View Lifecycle
o IBAction
o Delegate methods
o Private methods