Discussion :

[gaston11]

bonsoir a tous!
il y a quelques temps je suis tombé par hasard sur un site ou l'on proposais un utilitaire pour générer des noms de variables sous delphi avec le source

le fonctionnement était simple: on fournis le nom en claire de la variable désirée et lui nous générais une ou plusieurs variables significative.
a l’époque je n'avais pas tilté, mais depuis j'en aurais bien besoin mais impossible de retrouver le site!

si quelqu'un a ça sous la main.....

merci!!!!!

[guillemouze]

Quel est le but ? ce genre de pratique est utile si tu es obligé de fournir le code source pour executer le programme, comme en javascript par exemple. Mais delphi est un langage compilé, donc tu peux fournir un .exe sans le code, le reverse engineering est compliqué.

Mais bon, si c'est vraiment ce que tu cherche, ca s'appelle du "code obfuscation"

[gaston11]

Quel est le but ? ce genre de pratique est utile si tu es obligé de fournir le code source pour executer le programme, comme en javascript par exemple. Mais delphi est un langage compilé, donc tu peux fournir un .exe sans le code, le reverse engineering est compliqué.

Mais bon, si c'est vraiment ce que tu cherche, ca s'appelle du "code obfuscation"

non, c'est le contraire recherché!!
je me retrouve souvent faute d'imagination a utiliser toujours les même variable qui ne sont pas parlante! (x,y,z,a,b, heure, date, jour etc etc..)
l’outil en question donnais un nom de variable courte mais compréhensible

merci

[guillemouze]

Donc tu cherches un outils qui puisse comprendre sémantiquement ton code pour nommer tes variables mieux que toi automatiquement ?!
Genre renommer "x" en "nombre_de_passages" ?
Si c'est le cas, je crois que tu vis dans le monde des bisounours
Sinon, si tu cherche un outil qui, si tu renomme "x" en "toto", va te remplacer toutes les occurrences de ce x en toto dans la liste des var, ça s'appelle du refactoring.

[gaston11]

Donc tu cherches un outils qui puisse comprendre sémantiquement ton code pour nommer tes variables mieux que toi automatiquement ?!

non, c'est toi qui donne "l'utilisation" de ta variable du genre ' variable nombre de passage ' et lui te proposera 'Vnb_pass, Vnbre_pge, Vnbr_pas,Vnbr_passage,..' etc et a toi de chosir celle qui te plait.

c'est ce que j'ai compris en lisant le descriptif de l'outils, dommage que je ne le retrouve pas.

Si c'est le cas, je crois que tu vis dans le monde des bisounours
.

oui!!!!!! vive les bisounours!!!!!!!!!!!!!!!!!

merci

[Dr.Who]

c'est pour ça qu'il existe, et qu'il est important d'apprendre, les conventions d'écritures de code !

X,Y,Z -> coordonnées
i,n,m,d -> incrémenation / index

type -> T[Nom]
type interface -> I[Nom]
type exception -> E[Nom]
constantes -> pas de conventions ou MAJUSCULES_ET_UNDERSCORE ou c[Nom]
variable -> pas de conventions ou g[NomVariableGlobale] ou v[NomVariable] ou l[NomVariableLocale]
action sur evenement -> on[Nom evement]
type evenement -> T[Nom]Event


abréviations :
chaine = s[Nom], str
caractère = c[Nom], ch, cr
entier = i[Nom], int, ui, u, si
flottant = f[Nom], float, fl
enregistrement = rec, rd
resource = rc, rs, res
données = dt, data, dat
image = img, pic, im
graphisme = gfx, gx
sprite = sprt, sp
objet = obj, ob, o
liste = lst
tableau = arr, ar
arguments = a[Nom]
retour = r[Nom]
variable privée d'objet = f[Nom]
callback -> clbk, cbk, ck

etc.


Exemple :

Je dérive un TLabel pour pourvoir en customiser la couleur de fond (même si TLabel le fait déjà) :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
 
type TColoredLabel

j'en crée deux variables, en haut et en bas d'un panel :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
var
  PanelColoredLabelTop {PnlClLblTp}, 
  PanelColoredLabelBottom {PnlClLblBt} : TColoredLabel;

Je dérive une TListBox pour afficher des données d'un flux RSS

TRSSListBox

Je crée un triple boucle :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
var
  n0,n1,n2,n3: integer;
begin
  for n0 := 0 to 10 do
    for n1 := 0 to n0-1 do
      for n2 := 0 to n1-1 do
        for n3 := 0 to n2-1 do
        begin
        end;
end;

Ou encore une fonction qui permet de traiter un fichier :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
function ProccessFile(aFileName: Strings): int64;
var
  xFile : TFileStream;
  xBuffer : int64;
  xBufferSize : int64;
  rSum : int64;
begin
  rSum := 0;
  xBufferSize := SizeOf(xBuffer);
  xFile := TFileStream.Create(aFileName, fmOpenRead);
  try
    rSum := xFile.Size * xBufferSize;
    while xFile.read(xBuffer, xBufferSize) = xBufferSize do
    begin
      rSum := rSum + xBuffer; 
    end; 
    result := rSum;
  finally
    xFile.Free;
  end;
end;

[guillemouze]

c'est pour ça qu'il existe, et qu'il est important d'apprendre, les conventions d'écritures de code !

Je me rappelle d'une discussion (sur ce forum il me semble), qui traitait justement du prefixage des noms de variables, et, ce que j'en ai retenu (enfin ce qui a été dit et qui correspondait le plus à ma facon de penser), c'est que cette notation est pratique quand tu as un EDI peu évolué / adapté au langage. Les EDI modernes te proposent la completion typée, ce qui est plus pratique à mon gout que de se galerer avec des prefixes à tout va. Surtout si tu a des noms de variables comprehensibles, je trouve ca plus genant qu'autre chose. La seul exception à mes yeux est le nommage des composants (lblPolice, btnValider, ...).

[Charly910]

Bonjour,

moins chevronné que Guillemouze, je suis toutefois d'accord avec lui. Je n'utilise les préfixes que pour les types ( comme Dr Who : T[nom] par exemple) , et pour les composants (j'utilise L_Police ou Btn_Fermer par exemple).

Pour le reste afin que ce soit lisible j'utilise des majuscules et minuscules (je ne sais plus comment cela s'appelle !) - par exemple : NombreVoitures ou NbVoitures - c'est très lisible et on peu se passer d'underscores qui à mon avis nuisent à la lisibilité s'il y en a trop.

Sinon comme on est pas limité en nombre de caractères on peut rendre les noms de variables assez explicites (sans exagération sur la longueur !). Je préfère choisir moi même ces noms que de laisser ce soin à un logiciel.

pour les fonctions et procédures j'essaye d’utiliser un verbe dans le nom, pour désigner ce qu'elles font.

mais chacun ses habitudes. J'espère que les miennes ne sont pas trop mauvaises !


A+ Charly

[Dr.Who]

@Guillemouze :

Oui et non. Les conventions permettent de maintenir correctement un code quand on bosse à plusieurs dessus. Sinon ... c'est vite le chaos.
Il suffit d'aller se perdre dans quelques SVN bien pourri pour s'en rendre compte, l'un fait ci, l'autre fait ça ... aucune homogénéité, illisible, incompréhensible et giga-fastidieux quand on passe de l'écriture d'un dev à l'autre.

Dans mon équipe on switch entre Delphi, Php, Javascript, HTML et MySQL tout les codes sont écrit et indenté strictement pareil. ça reduit les temps de formation et d'explication par 10 avec les nouveaux.

exemple :

Delphi :

Code delphi :

Sélectionner tout - Visualiser dans une fenêtre à part

function TCore.DecXY(aX, aY: integer): TPoint;

PHP

Code php :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
class TCore  {
  public function DecXY(aX, aY){...

JavaScript

Code javascript :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
var TCore = {
  create: function(){
    var __constructor = arguments;
    var __implementation = {
      DecXY : function(aX, aY){...

L'EDI ne fait pas tout. Mets un marteau et un burin dans les mains d'un lambda ... il te fait un truc pourri. Mets les dans les mains d'un sculpteur professionnel, tu obtient une oeuvre d'art.

@Charly :

Cela s'appelle la notation "Dos de chameau" -> nomDeMaVariable

notation C -> variable_truc et CONSTANTE_BIDULE


Pour ce qui est de l'utilisation des verbes, adverbes et des adjectifs voici un exemple :

fonction -> Initialize
region -> Initialization
état (Initialization state set)-> istNotInitialized, istInitialization, istInitialized
control bool -> isInitialized, isNotInitialized (<- conjugué, est ou n'est pas initialisé )
appel d'evenement -> doInitialize
evenement -> TBeforeInitializeEvent, TInitializeEvent, TAfterInitializeEvent
message -> UMBeforeInitialize, UMInitialize, UMAfterInitialize
propriété evenement -> OnBeforeInitialize, OnInitialize, OnAfterInitialize
type class -> TInitializer
variable d'instance -> Initializer
divers -> InitializerCreator, InitializationSynchronizer, InitializeControler, InitializationGarbage etc.


par contre les fonctions et procedure ne sont pas conjugué (pas tout le temps) donc indicatif ... ça indique ce que ça fait très bien (en anglais sans le To ) !

incrementer (inc)
decrementer (dec)
deplacer (move)
copier (copy)
effacer (delete)
appliquerNoirEtBlanc (applyBlackAndWhite, applyBW )
inverserImage (invertPicture)
calculer (calc)
créer (create)
detruire (destroy)
compter (count)
empiler (push)
dépiler (pop)
écraser (erase)

les propriété sont plutot des noms :
élements (Items)
composants (Components)
chaines (Strings)
coordonnéeX (X)
coordonnéeY (Y)
hauteur (Height)
Longueur (Width)
Style (")
Typographie (Font)
Couleur (Color)
Haut (Top)
Bas (Bottom)

exception des propriété de control en lecture seule :
estEnHaut (property isOnUp: boolean index esUp read getStateBool)
estEnBas (property isOnDown: boolean index esDown read getStateBool)

[Montor]

pour compléter

type Pointer -> P[Nom]

champs F[Nom]
argument A[Nom]
getter Getxx
setter Setxx

il suffit de regarder dans les anciennes source pascal pour comprendre sa pertinence

[ShaiLeTroll]

Oui et non. Les conventions permettent de maintenir correctement un code quand on bosse à plusieurs dessus. Sinon ... c'est vite le chaos.

Il n'y a rien de plus difficile que de suivre une charte de code que l'on approuve pas ou pire : qui n'est pas clairement défini
genre le prefixe sz pour des fois char* mais aussi pour AnsiStringet parfois c'est as ou str.

Lors de la création d'un projet en Zend PHP 5.2, on avait posé des règles comme Anglais comme langue de référence pour le code, le français réservé pour les commentaires pour les pas très doué comme moi
Il y en a TOUJOURS UN pour écrire du code en Français, à ne pas respecter les consignes de nommages de fichier, de classe, ni même à respecter l'architecture choisie de Zend avec le boostrap, le Zend_Loader, Zend_Form et tout ce qui avec et pas une saleté de prepend.php foireux !)


Pour ma part, en Delphi\BCB, je n'utilise qu'une seule et UNIQUE référence à ce sujet : Object Pascal Style Guide :

Delphi is created in California, so we discourage the use of notation, except where required in header translations... The exception to the Hungarian notation rule is in enumerated types.

Je pense aux API Windows, je cherche pas à faire compliquer, je prends le nom des paramètres si j'ai besoin de faire une locale, du coup tu as lpstrz

Dans mon équipe on switch entre Delphi, Php, Javascript, HTML et MySQL tout les codes sont écrit et indenté strictement pareil. ça reduit les temps de formation et d'explication par 10 avec les nouveaux.

Tu impose donc le T pour Type en PHP, je le comprend, nous on a choisi C pour le PHP, il n'y avait pas de convergence entre le Delphi et le PHP à ce sujet
C'est compréhensible pour un dev Delphi qui s'ouvre à d'autres langages mais pour un expert PHP qui débarque avec ses habitudes ainsi que son égo
En tout cas, c'est un beau travail d'équipe chez Who !
j'en suis loin

Pour le reste afin que ce soit lisible j'utilise des majuscules et minuscules (je ne sais plus comment cela s'appelle !)

le CamelCase
EDIT : ah, cela avait déjà été dit mais en français !

Sinon comme on est pas limité en nombre de caractères on peut rendre les noms de variables assez explicites (sans exagération sur la longueur !).

63 caractères maximum pour un nom de fenêtre, le code semble accepter plus mais pas la DFM, la documentation évoque cela : System.SysUtils.IsValidIdent !
Dans le genre, je n'aime pas les limites :

Code c++ :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
TShaïDVRDahuaTechnologyClientAVIConverterFromMonitorStream
TShaïDVRDahuaTechnologyLinkedCameraAdvancedFeatures_Generic
TShaïDVRDahuaTechnologyRecorderByDownloadableTrigger_Generic
IShaïCameraEntityRecordingTriggerIsDownloadableDelphiInterface

Le vrai préfixe n'est pas Shaï mais le code projet que je maintiens !
Oui, je suis à la limite, j'avais même tenté un
TShaiDVRDahuaTechnology_DH_DVR0404LE_LinkedCameraConfiguratorForm qui devenu plus modestement
TShaiDVRDahuaTechnology_Generic_CameraConfiguratorForm.

pour les fonctions et procédures j'essaye d’utiliser un verbe dans le nom, pour désigner ce qu'elles font.

C'est d'ailleurs comme cela que l'on reconnait un attribut d'une méthode comme l'a si justement décrit Le Docteur !

Method names should be imperative verbs or verb phrases.

Avantage au C++ qui oblige () pour une méthode sans paramètre, même en Delphi, je le pratiquais


PS for Dr. Who :

Delphi :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

function TCore.DecXY(aX, aY: integer): TPoint;

PHP [code=php] ... [/code]

Code php :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
class TCore  {
  public function DecXY(aX, aY){...

JavaScript [code=javascript] ... [/code]

Code javascript :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
var TCore = {
  create: function(){
    var __constructor = arguments;
    var __implementation = {
      DecXY : function(aX, aY){...

[guillemouze]

A ce propos, j'ai vu un truc carrément sympa en Ruby : la ponctuation (non obligatoire je crois mais très utile.
- "?" pour Une fonction booleenne, : "myArray.Empty?"
- "!" pour une méthode qui modifie l'objet : "myArray.deleteIf!(condition)"

[Dr.Who]

Il n'y a rien de plus difficile que de suivre une charte de code que l'on approuve pas ou pire : qui n'est pas clairement défini

Lors de la création d'un projet en Zend PHP 5.2, on avait posé des règles comme Anglais comme langue de référence pour le code, le français réservé pour les commentaires pour les pas très doué comme moi
Il y en a TOUJOURS UN pour écrire du code en Français, à ne pas respecter les consignes de nommages de fichier, de classe, ni même à respecter l'architecture choisie de Zend avec le boostrap, le Zend_Loader, Zend_Form et tout ce qui avec et pas une saleté de prepend.php foireux !)

C'est bien certain, avantage, dans mon équipe on à que des delphiistes donc habitué aux conventions Borland.
On à introduit ces règles quand on a constaté qu'on avait exactement les mêmes habitudes de coder tout à la delphi. On à créer un petit carnet d'une 20ene de pages pour expliquer tout.

Si le mec ne sais pas se mettre au même rythme, on le pousse, si il n'en veut faire qu'a sa tête ... la période d'essais dure pas longtemps ...
[anecdote]
comme le mec qui nous à foutu le brin dans une très grosse API ... heureusement que les outils de refactoring existe mais on a perdus 2 jours de boulot pour tout remettre en état ...
je l'oublierai pas son "oui oui j'ai compris"...

Du coups maintenant on fait 2x3H de tests des nouveaux bonhommes Le test consiste à construire une table mysql contenant des données logistique + une Api de branchement en PHP + affichage HTML5+JQuery et administration des données en Delphi.
sur le panel 2012 (11 candidats), 8 ont échoués , 3 seulement ont réussit dans le temps impartis, 1 seul à eu le temps de commenter sommairement et la table MySQL et les 3 sources
[/anecdote]

Tu impose donc le T pour Type en PHP, je le comprend, nous on a choisi C pour le PHP, il n'y avait pas de convergence entre le Delphi et le PHP à ce sujet
C'est compréhensible pour un dev Delphi qui s'ouvre à d'autres langages mais pour un expert PHP qui débarque avec ses habitudes ainsi que son égo

Oui vus que PHP, Javascript ne sont pas typé la notion de Type (T) est donc un peu vague pour un Dev PHP/JS. Mais on à la chance d'avoir des bons quand même.
On prend donc le language le plus disciplinant et strict comme base de référence, donc Delphi.

En tout cas, c'est un beau travail d'équipe chez Who !
j'en suis loin

Je m'estime chanceux d'avoir d’excellents et cocasses équipiers oui.

le CamelCase
EDIT : ah, cela avait déjà été dit mais en français !

PREUMS !

PS for Dr. Who :

Bien vus, j'ai corrigé

A ce propos, j'ai vu un truc carrément sympa en Ruby : la ponctuation (non obligatoire je crois mais très utile.
- "?" pour Une fonction booleenne, : "myArray.Empty?"
- "!" pour une méthode qui modifie l'objet : "myArray.deleteIf!(condition)"

Un truc basé sur la ponctuation mais faut que ce soit fait intelligemment et que ça reste intuitif.
style BrainFuck :

"Bonjour j'ai un soucis avec mon code :
++++++++++[>+++++++>++++++++++>+++>+<<<<-]>++.>+.+++++++..+++.>++.<<+++++++++++++++.>.+++.------.--------.>+.>.

je crois que c'est +++.>.++>.-. et pas <<->+.-. pouvez vous m'aiday ?

" ... Hahaha mais aucun problème "