INFOTEL VOUS REMERCIE POUR VOTRE CANDIDATURE

Un chargé de recrutement prendra contact avec vous prochainement.

Clean code : le nommage

Clean code : le nommage

« Le nommage, la première chose qu’un développeur apprend, mais aussi la première chose qu’il oublie. »

« Rendre son code lisible c’est faciliter sa compréhension. Comprendre le code c’est pouvoir le maintenir. »

Chez Infotel, un développeur peut être amené à travailler sur des maintenances applicatives, or, pouvoir maintenir du code, c’est répondre au besoin du client. La règle de base du nommage est de communiquer l’intention. Chaque nom de classe, interface, abstraction, ou variable doit être aussi claire que possible sur ce qu’elle fait.

Au cours de cette session, Michelle Avomo, développeuse FullStack Java/Front, nous présente les règles de base du nommage. A travers des exemples pratiques, elle nous montre qu’un code intentionnellement inintelligible peut être rendu compréhensible par un nommage propre des variables et des méthodes de la classe.

Les points importants

  • Nous écrivons du code d’abord pour les humains et non pour les machines.
  • Le nommage est une décision d’équipe : il est important de toujours discuter des conventions à adopter avec ses pairs.
  • Toujours communiquer l’intention : les noms que nous assignons aux variables permettent de comprendre ce que fait le code sans lire toute l’implémentation.
  • Privilégier la communication : des noms prononçables permettent de fluidifier la communication au sein de l’équipe.
  • La portée (« scope ») influence la taille des noms “recommandables” : ils devraient toujours être aussi courts que possible, mais aussi longs que nécessaire.

La mise en pratique

Quelques exemples

Quelques règles usuelles et bonnes pratiques

Focus

Les noms des variables et des méthodes devraient toujours être aussi courts que possible, aussi longs que nécessaire.

The « Scope Lenght Rule »

La règle du scope prend en compte la portée des variables et des méthodes pour déterminer leur taille « recommandable » :

  • Pour une variable : Plus sa portée est grande, plus son nom doit être explicite (nom de variable plutôt long).
  • Pour une méthode/une classe : Plus elle est exposée, plus son nom devrait être générique, donc court.

Conclusion

Au sein de mes différentes expériences, j’ai pu constater que le clean code et notamment le nommage sont souvent délaissés au profit de la quantité et des délais. Or, le temps et l’effort investi par un développeur à comprendre un code pour le faire évoluer ou le maintenir peut-être capitalisé en employant ces pratiques.  En agilité, le nommage peut se décider en équipe et s’inscrire dans la « définition du fini » qui valide les réalisations. Au final, ces pratiques simples sont essentielles au bon maintien de la connaissance du patrimoine applicatif d’un client. Et surtout, vos successeurs vous remercieront !

Par Mathieu DB.

banque

Banque

Traitement automatisé des demandes de prêt et simplification du KYC "Know Your Customer".

Fonctionnement

  • Amélioration du KYC et embarquement des clients en vérification automatiquement l'identité des nouveau clients grâce au traitement intelligent des documents d'identité sur le web ou dans une application.
  • Accélération des demandes de prêts et d'hypothèques : traitement et classification automatique des documents entrants, extraction des informations et validation des points de données.
  • Prévention de la fraude et respecte des règles : automatisation des contrôles de conformité réglementaire sur les contrats, les documents financiers et les documents d'identité.
  • Facilitation et simplification de la compréhension des dépenses des consommateurs : classification des transaction bancaires en lisant les données des postes de reçus et de factures.
Brevets

Brevets

Traitement automatisé des documents scientifiques et autres documents liés au dépôt de brevet pour la propriété intellectuelle.

Fonctionnement

  • Reconnaissance et indexation automatique des champs pour une recherche précise parmi les documents relatifs au dépôt de brevet.
  • Uniformisation des documents en lien avec les spécifications qui sont ainsi mis à jour : bibliographie, brevet expiré, brevet renouvelé, etc.
Comptabilité

Comptabilité

Traitement automatisé des reçus, factures et autres documents financiers etc.

Fonctionnement

  • Automatisation des processus comptable : réconciliation des comptes bancaires, déclaration de TVA, saisie des factures fournisseurs.
  • Standardisation et harmonisation des processus comptables de l'entreprise.
  • Sécurisation de la qualité des données en supprimant les erreurs manuelles et en synthétisant les contrôles.
  • Contribution à la réduction des risques de fraude, renforcement de la sécurité des opérations, la pise d'audit et le contrôle interne.
  • Accompagnement dans la conduite du changement et des équipes comptables sur l'appropriation de cette nouvelle solution.