Ubiquitous Network Wiki

Cette page est en lecture seule. Vous pouvez afficher le texte source, mais ne pourrez pas le modifier. Contactez votre administrateur si vous pensez qu'il s'agit d'une erreur.
====== 20 Meilleures Pratiques ====== 
  - La **justesse**, la **simplicité** et la **clarté** passent en premier.
  - Évitez l'**ingéniosité** inutile. Si vous devez compter sur l'ingéniosité, encapsulez-la et commentez-la.
  - Évitez la duplication ([[http://en.wikipedia.org/wiki/Don't_repeat_yourself|DRY]]).
  - Couplage et Cohésion. Les systèmes doivent être conçus comme un ensemble de modules cohésifs aussi peu couplés que raisonnablement possible.
  - Masquage des données. Minimisez l'exposition des détails de l'implémentation.
  - Minimisez la portée des variables, pragmas, etc.
  - Établissez une politique de gestion des erreurs rationnelle et suivez-la strictement.
  - Les interfaces sont importantes. Une fois qu'une interface devient largement utilisée, la changer devient pratiquement impossible (à peu près tout le reste peut être corrigé dans une version ultérieure). Concevez d'abord l'interface du module.
  - Conception des interfaces qui sont : cohérentes ; faciles à utiliser correctement ; difficiles à utiliser incorrectement ; faciles à lire, à maintenir et à étendre ; clairement documentées ; adaptées à votre public. Soyez suffisant, pas complet ; il est plus facile d'ajouter une nouvelle fonctionnalité que de supprimer une malfaçon.
  - Écrivez des composants testables de manière isolée.
  - Le résultat de chaque opération de fichier, appel API ou commande externe doit être vérifié, et les résultats inattendus doivent être gérés.
  - Utilisez des noms descriptifs, explicatifs, cohérents et réguliers. [[fr:devmon:guidelines:variables|(voir variables)]]
  - Évitez les nombres magiques.
  - N'optimisez pas prématurément. Effectuez des tests de performance avant d'optimiser. Commentez pourquoi vous optimisez.
  - Mettez-vous d'accord sur un style de mise en page cohérent et automatisez-le. [[fr:devmon:guidelines:tidy|(voir tidy)]]
  - Adoptez une politique de tolérance zéro pour les avertissements et les erreurs. Des outils tels que Perl::Tidy et Perl::Critic peuvent vous aider ici. [[fr:devmon:guidelines:tidy|(voir tidy)]]
  - Commenter : préférez rendre le code évident ; ne répétez pas l'évident ; les commentaires décrivent le quoi et le pourquoi, pas le comment.
  - Séparer la documentation utilisateur de la documentation de maintenance.
  - Utilisez un système de contrôle de révision [[https://github.com/bonomani/devmon]] et un processus de construction/test automatisé en une seule étape.
  - **"Codez toujours comme si le gars qui finira par maintenir votre code sera un psychopathe violent qui sait où vous habitez"** (Damian Conway)