Aller au contenu
Funky-Emulation Recrute
The Falcon

 tutoriel / partage [VB][GUIDE] Les Bonnes Pratiques

Messages recommandés

Introduction

 

Bonjour, 

J’ai vue qu’une relance du forum était en cours et j’ai donc choisi ce moment pour aider un peu. Je ferais quand j’aurais du temps libre des tutoriels sur le VB.NET ou autres.

 

Le VB.NET

 

Avant de commencer à parler des bonnes pratiques de programmation en VB.NET regardons de quoi il s’agit.

Visual Basic .NET est un langage de programmation à la syntaxe similaire à celle de Visual Basic 6.

 

 

VB.NET permet de développer en .NET via Visual Studio (Version Express gratuite), sur les systèmes d'exploitation Windows (98, 2000, XP, Vista, 7, 8, 8.1 et 10). Comme tout autre langage de la plateforme .NET, VB.NET est compilé vers le langage intermédiaire CIL. 

 

Les Bonnes Pratiques

 

Le Programme

 

 - Toujours bien définir votre programme : Les fonctionnalités, les limites, les interactions

 

 - Faire un diagramme : Use case,  de classe, de séquence

 

 - Toujours pensez aux autres technologies, langages qui seront utilisé et comment vous allez interagir avec elles. (D’où l’utilité du Use Case)

 

 - Il faut toujours penser à simplifier votre programme au plus utiliser des Classes, Modules, créer des Fonctions, Subs dès que possible.

Example :

LogHandler.vb 'comme module pour logs

                LogWriter()

                LogReader()

 

Les Noms

 

 - Il faut toujours penser à bien nommer ses variables. Il faut avoir un nom concis et qui soit intuitif.

Example :

RecupProchainItemArray()

RecupProchainEtudiant

 

 - Il faut limiter la redondance surtout dans des propriétés de classes.

Example :

Livre.LivreTitre

Livre.Titre

 

 - Il faut rester cohérent sur l’appellation des variables.

Example :

Dim Livre, Vase, television, emulateur As String

Dim Livre, Vase, Television, Emulateur As String

Ou

Dim livre, vase, television, emulateur As String

 

 - Pensez à utiliser des noms pouvant signaler le rendue d’une fonction. Typiquement l’utilisation du mot « Est » pour dire que la fonction rendra un boolean.

Example :

 

Numerique(integer)

EstNumerique(integer)

 

Les Commentaires

 

 - Il faut toujours, toujours,  toujours commenter son code ! Que ce soit pour mieux vous repérez, pour aider à la compréhension. Vous ne savez jamais qui vous aidera à debug ou résoudre un problème.

 

 - Pensez à écrire un commentaire avant chaque Fonction ou Sub expliquant son but et comment l’appeler.

 

 - Ne vous cassez pas la tête à faire des jolis commentaires avec des cadres etc… Utilisez la simplicité telle qu’une ligne vide pour séparer commentaire du code. C’est plus simple à maintenir sur de gros programmes.

 

 - S’il vous faut écrire un long commentaire pour décrire quelque chose de complexe il y a de forte chances que ce que vous avez codé soit trop complexe et pas simplifié comme il le faut.

 

 - Gardez la même ponctuation ! Soit vous mettez un point à chaque phrase soit à aucune mais pas juste au feeling !

 

Conseils Globaux

 

 - Pensez à indenter votre code !

Example :

 

If … Then
If … Then
…
Else
…
End If
Else
…
End If

 

 

 

If … Then
    If … Then
         …
    Else
         …
    End If
Else
    …
End If

 

 - Si vous utilisez des classes utilisez des propriétés privé et utilisez une fonction pour retourner la valeur.

 

 - Pensez à la gestion d’erreur ! Utilisez des Try Catch et utilisez du Logging pour savoir où se sont passées les erreurs chez des clients.

 

Ressources et consommation :

 

  • Tous les éléments possédant la propriété IDisposable peuvent être utilisés avec un USING qui jettera automatiquement l’élément ce qui libèrera des ressources.
  • Pensez à limiter votre data et utilisez que le nécessaire si vous avez une base de 3 Millions de lignes récupérez les à coup de 100 000 avec une boucle.
  • Pensez à utiliser le Garbage Collector si vous gérez beaucoup de données.

 

 

Conclusion

 

Il y a beaucoup d’autres pratiques qui peuvent être implémentées mais je pense que ceci sont celle de base qui vous pousserons à améliorer votre code. Pensez aussi à utiliser GitHub pour gérer vos projets Open Source.

Partager ce message


Lien à poster
Partager sur d’autres sites

 - Faire un diagramme : Use case,  de classe, de séquence

 

Ah les diagrammes UC, Classe et de Séquence, que c'est pénible à faire :)

 

Sinon pour le nommage des variables, il y a une pratique c'est de mettre le type de la variable dans le nom, par exemple :

bool bPermis = false; // possède un permis ?

String sNom = "Nom de famille";

Ça permet d'identifier rapidement la variable dans le code et ça évite de remonter en haut de page si la variable est en définie en haut de page.

Partager ce message


Lien à poster
Partager sur d’autres sites

 - Faire un diagramme : Use case,  de classe, de séquence

 

Ah les diagrammes UC, Classe et de Séquence, que c'est pénible à faire :)

 

Sinon pour le nommage des variables, il y a une pratique c'est de mettre le type de la variable dans le nom, par exemple :

bool bPermis = false; // possède un permis ?

String sNom = "Nom de famille";

Ça permet d'identifier rapidement la variable dans le code et ça évite de remonter en haut de page si la variable est en définie en haut de page.

 

Oui le type de variable est pratique mais c'était implicite quand je disais de choisir un nom intuitif

Oui les diagramme sont chiant mais sur un gros projets type emulateur, bot etc c'est très pratique ;)

Partager ce message


Lien à poster
Partager sur d’autres sites

Merci pour le partage de ce tutorial! :)

Partager ce message


Lien à poster
Partager sur d’autres sites

Ah les diagrammes UC, Classe et de Séquence, que c'est pénible à faire :)

 

+1 -_-

 

 

Sinon j'ajouterai ne pas coder en français. C'est plus clean :P

Partager ce message


Lien à poster
Partager sur d’autres sites

Sinon j'ajouterai ne pas coder en français. C'est plus clean :P

 

Ça évitera que des personnes écrivent avec des accents, qu'est ce que j'en ai vu pendant les cours de Java :)

Partager ce message


Lien à poster
Partager sur d’autres sites

×

Information importante

By using this site, you agree to our Conditions d’utilisation.