Règles à suivre avant de déposer une source (un programme)

Dernière mise à jour le par pijaku .

Règles à suivre avant de déposer une source (un programme)

Introduction

Ce tutorial n'est pas extraordinaire, mais à mon avis important. Je l'ai écrit pour les débutants (et même parfois les moins débutants) qui postent des sources très difficiles à étudier. En effet, certaines sources peuvent être bien dans le fond (l'idée, la démarche de programmation), mais si on n'arrive pas à analyser le code, elle ne sert a rien (on ne cherche pas des softs ici, mais plutôt à apprendre).

Les commentaires

Un code doit être commenté. Cela est très important, pour vous, pour nous, et pour la société (si vous êtes travailleur).

  • Pour vous, parce que vous êtes un Homme, et l'homme ça oublie. Donc, si dans 5 mois vous décidez de faire une mise a jour de votre programme, en lisant le code cru, vous ne saurez même pas ce que telle ou telle ligne fait (Il faut rechercher, et cela perd le temps).
  • Pour nous, parce que nous sommes là pour apprendre. Si nous prenons la peine de télécharger une source parce que le thème nous intéresse, il serait intéressant d'y comprendre quelque chose. On ne doit pas imaginer ce que vous voulez faire à telle ou telle ligne. Les débutants ne pourront rien apprendre, puisque le code est nouveau pour eux, et vous ne leur expliquez pas à quoi il sert. En même temps, vous n'apprendrez pas, puisque si votre code n'est pas commenté, les plus initiés ne sachant pas ce que vous voulez faire exactement ne pourront pas vous aider à améliorer.
  • Pour la société, parce que si vous tombez un jour malade, ou si vous êtes licencié (je ne le souhaite pas) celui qui vous remplace dois savoir dans quel esprit vous avez programmé.

Nommer les objets

Les objets que vous utilisez doivent être nommés. Et cela, pour les mêmes raisons citées plus haut.

Un code doit "parler". il ne faut pas que celui qui le lit soit obligé de faire des centaines de va et vient entre le code, et les formes pour savoir ce que vous faite.

Je m'explique.
Lorsque vous mettez un nouveaux TextBox, le nom par défaut est "Text1", ou "Text15" si c'est le 15ème TextBox que vous utilisez.

Pareil pour les "Label", les "ComboBox", les "ListBox", les "CommandButton". ..

Voici un code pris d'une source. (frère, si j'ai pris ton code pour exemple, c'est parce que c'est le dernier que j'ai vu. pas en mal)

Private Sub Command18_Click()
Width = 11655
Height = 11415
Left = 5520
Top = 720
Visible = True
Visible = False
Visible = True
Visible = False
Visible = True
Visible = True
Visible = True
Visible = True
Visible = True
Visible = True
Visible = False
Visible = False
TextBox17 = TextBox2
End Sub

Vous êtes d'accord avec moi, qu'en lisant ce code, vous ne saurez jamais ce qu'il fait.

Comment nommer les objets?
(Je ne sais plus ou, mais je l'avais déjà dit pour une source)
Il faut que le nom que vous donnez a vos objets permettent de savoir quel est le type de l'objet, son rôle dans la source, et doit être lisible.

Pour cela, le nom commencera par 3 lettres représentants le type, avec la première lettre en majuscule.

"Txt" pour TextBox
"Lbl" pour Label
"Cmd" pour CommandButton
"Cbo" pour ComboBox
"LstB" pour Listbox
"LstV" pour ListView
"Pic" pour Picture
"Img" pour image

Puis, le rôle de l'objet, résumé en 3 lettres, 6 lettres si composé. Et commence par une majuscule.

Exemple:
Une Commande qui serviraà supprimer un enregistrement s'appellera : "CmdSup"
Un TextBox dans lequel on écrira le Nom de la Société, s'appellera : "TxtNomSoc"
Son étiquette (Label) s'appellera : "LblNomSoc"

Pareil pour tous les autres.

Nommer les formes, modules, etc.

Les formes, modules, OCX doivent être nommés.

Le nom, tout comme pour les objets, doit permettre de connaitre le rôle du form, ou du module dans le programme.

Le Formulaire de démarrage du programme pourra s'appeler "FrmDemarrage".
"Frm" pour form, et le nom au maximum explicite.

Le module qui contient les déclarations s'appellera "MdlDeclaratio".
"Mdl" pour Module, suivi du nom.

Remarque : Chaque "mot" doit commencer par une majuscule. Cela pour mieux voir et lire le nom.
Vous pouvez faire comme pour la remarque de PCPT, Form_Nom plus lisible.
Et toujours dans la même remarque, évitez les accents.

Note :

Il faut vérifier avant de poster une source, si elle n'existe pas déjà sur le site. Si elle existe, la poster ne sert a rien. Modifiez la plutôt en y ajoutant des options qui n'existent pas chez les autres, et en utilisant un code plus simple.

Je mets cela en Note, même si c'est ce qui devait être en 1er, parce que cela est déjà dit avant de poster une source.

J'ai écrit ce tutorial en quelques minutes, je sais que ce n'est pas la merveille. Mais je le redis, c'est important.

Il y aura des mises à jours, pour en faire un truc consistant.

Pour ceux qui répètent souvent les 3 règles, il vous suffit maintenant de mettre le lien :)

Ce document intitulé « Règles à suivre avant de déposer une source (un programme) » issu de CodeS SourceS (codes-sources.commentcamarche.net) est mis à disposition sous les termes de la licence Creative Commons. Vous pouvez copier, modifier des copies de cette page, dans les conditions fixées par la licence, tant que cette note apparaît clairement.
Un bon tutoriel sur les conversion decimale --> hexadecimales et inversement
Les bases pour se connecter une base de données access avec vb.net
Rejoignez-nous