Discussion :

[Bovino]

M�me mal comment� ?

La premi�re documentation c'est le code lui m�me, avec des noms de symboles bien r�fl�chis, sans abr�viations et sans aucune touche de folklore. Pas de concession l� dessus. S'il manque du temps le code sera assez expressif sans documentation pour qui veut vraiment s'en servir.

Mettre des commentaires pour mettre des commentaires ?.. Des clous ! �a ne vaut rien. Quand on �crit un commentaire on doit se placer - et c'est assez difficile - � la place de celui qui passe par l� et qui lit. Bien trop souvent on tombe sur des commentaires qui ne veulent strictement rien dire et qui, finalement, ne font que polluer l'espace visuel et, pire, perdre le lecteur.
Le plus comique �tant lorsqu'ils doivent �tre �crits dans une langue �trang�re et que l'auteur ne la ma�trise pas. Remarquez, quand parfois on en lit en fran�ais on est tout aussi paum�s...

C'est pas faux tout �a !
Effectivement, le nommage est tr�s important, � mon avis, une variable, un param�tre etc. doivent �tre nomm�s en fonction de ce qu'ils repr�sentent en terme de contenu, pas de contenant, par exemple, nommer une variable qui va cr�er une div � ins�rer dans le document devra plus s'appeler "ajout_documentation_article" que "nouvelle_div".
Ceci dit, les commentaires sont aussi importants, � condition d'�tres mis � jour en m�me temps que le code, ne serait-ce que pour soi-m�me ou ses coll�gues, mais tu as raison d'enfoncer le clou : dans la mesure ou ils sont pertinents et explicatifs !
Qui n'a jamais vu dans un code des trucs du genre :

Code :

S�lectionner tout - Visualiser dans une fen�tre � part

1
2
3
4
// fonction de calcul
function calcul(){
...
}

[Oscar Hiboux]

LOL, c'est typiquement �a !!

[le_chomeur]

mouai je parle naturellement de commentaires constructif ^^
sans lancer la pierre pas comme certain de ce post :sifle:

sinon pour spaffy et sa requ�te sur les fonctions avanc� en js , closure, h�ritage etc, r�cup�re le livre que bovino a commenter il est vraiment g�nial !!

[Bovino]

:sifle:

Ce smiley n'existe pas

sinon pour spaffy et sa requ�te sur les fonctions avanc� en js , closure, h�ritage etc, r�cup�re le livre que bovino a commenter il est vraiment g�nial !!

Oui, je confirme

[marcha]

+1 Oscar Hiboux, et les r�ponse suivantes.

Puisqu'on parle du nommage et du code qui devrait pouvoir �tre clair sans commentaires,
il y a une bonne pratique que j'essaie de respecter qui consiste � maintenir la coh�rence
de nommage au travers des diff�rentes fonctions.

Un exemple pour illustrer une incoh�rence:

Code :

S�lectionner tout - Visualiser dans une fen�tre � part

1
2
3
4
5
6
7
8
 
function afficher(e) {
   e.style.display = 'block';
}
 
function masquer(element) {
  element.style.display = 'none';
}

e et element repr�sentent la m�me chose et devraient avoir le m�me nom. Ici l'exemple
est trivial, mais je suis souvent confront� � ce probl�me lorsqu'il y a beaucoup de
fonctions.

[kernelfailure]

. . .
bannir document.write()
. . .

Ca fait plusieurs fois que je lis que certains expriment le d�sir de ne plus utiliser cette m�thode sans bien comprendre leur motivation.

Pourquoi tant de haine ?

. . .
Ah oui, pour la notation hongroise, pr�fixer par le type est inutile ou presque un tr�s bon article qui explique le malentendu de cette notation Joel on software

Je comprends mieux pourquoi aujourd'hui encore je trouve inutile l'emploie de ui32Machin ou LPTRBidule etc... La belle affaire d'avoir ce genre d'information, surtout ici, pour du javascript.
En revanche, l'aspect originel est plut�t int�ressant. C'est bien dommage que cette notion, cette vraie utilit�, ait �t� mal comprise et d�grad�e.

J'ai toujours trouv� ce 'typage' p�nible, et je trouve �a particuli�rement ridicule et inadapt� � la programmation objet.
Simple : il faudrait inventer autant de type que d'objets.
Or la tendance est de n'accorder de l'int�r�t que pour les types basiques (limit� sous JS), ce qui devient un tour de force sous Python (O� tout est objet).

. . .
On peut penser que la variable "iModeSearchSelected" indique l'ID du mode de recherche actuellement s�lectionn�.
. . .

Justement, un simple "idSearchMode" (pour identifiant de mode de recherche) ou "usrSearchMode" (pour mode de recherche de l'utilisateur - donc s�lectionn�) seraient beaucoup plus parlant.
Ou pourquoi pas "idxSearchMode" s'il s'agit d'un index (selected).
Le fait que la valeur soit stipul�e comme enti�re n'est pas d'un grand int�r�t.
D'ailleurs, le nom est bien plus important, "searchMode" plut�t que "modeSearch"

Mais 'i' pour 'integer' ou 'instance' ?
Oui, parce que j'ai d�j� vu des 'o' pour qualifier des instances...
Donc, 'var oI = new Integer();' tandis que 'var iI = 0;' ne serait pas pareil.

Tout n'est pas noir ou blanc, et dans le genre, je trouve plut�t bien de fortement qualifier les param�tres de m�thodes et fonctions, par exemple, en nommant clairement le type d'instance attendu, genre 'dateDeparture' ou 'instanceUser' ou 'amtBooking' ou 'amountBooking'.
Mais je pr�f�re lire 'amount' que 'float' ou 'fAmount' ou 'fAmt'...

[Oscar Hiboux]

J'ai toujours trouv� ce 'typage' p�nible, et je trouve �a particuli�rement ridicule et inadapt� � la programmation objet.
Simple : il faudrait inventer autant de type que d'objets.

Je dirais plus : "ridicule et inadapt�" surtout aux langages � types forts o� il est impossible de se tromper sinon �a ne compile m�me pas. D'ailleurs, pour ces langages, tout bon IDE reconnait le types des entit�s manipul�es et les colore et pr�sente de bien belles mani�res. Pour les autres �a pourrait se comprendre, quand l'�quipe au complet est rigoureuse (ce qui n'arrive que tr�s tr�s rarement). Donc inadapt� ? Assez souvent, du fait du temps d'adaptation � la pratique lorsqu'un membre int�gre une �quipe et au temps perdu par l'incompr�hension passag�re d� au mauvais emploi de ces petits pr�fixes et la diminution de lisibilit� du code assez rapidement.
Je me souviens avoir vu passer des "xDog" dans certains projets employant ce genre de pr�fixes pour signifier qu'on manipulait un noeud XML... �a peut conduire loin ! (P.S. : j'aimais bien l'id�e, ahah)

[...]"idSearchMode" (pour identifiant de mode de recherche) ou "usrSearchMode" (pour mode de recherche de l'utilisateur - donc s�lectionn�) seraient beaucoup plus parlant.
Ou pourquoi pas "idxSearchMode" s'il s'agit d'un index (selected).
Le fait que la valeur soit stipul�e comme enti�re n'est pas d'un grand int�r�t.

Hmm, "idSearchMode" conviendrait mieux � "mode de recherche d'identifiant", non ?
"usrSearchMode" ? Pourquoi s'�corcher les yeux et ne pas �crire pleinement "userSearchMode" ? Pareil, "idxSearchMode" ? "searchModeIndex", non ? �a sert � quoi d'�conomiser 2 caract�res pour sacrifier la lisibilit� ?

[...]je trouve plut�t bien de fortement qualifier les param�tres de m�thodes et fonctions, par exemple, en nommant clairement le type d'instance attendu, genre 'dateDeparture' ou 'instanceUser' ou 'amtBooking' ou 'amountBooking'.

Allez, dans la s�rie... "dateDeparture", c'est le d�part de la date ? "instanceUser" L'utilisateur-instance ? L'utilisateur de l'instance ? "amtBooking" ? Ah, on �conomise 3 caract�res, hihi.

D'ailleurs, le nom est bien plus important, "searchMode" plut�t que "modeSearch"

En effet, ahah !

[...]je trouve plut�t bien de fortement qualifier les param�tres de m�thodes et fonctions, par exemple, en nommant clairement le type d'instance attendu, genre 'dateDeparture' ou 'instanceUser' ou 'amtBooking' ou 'amountBooking'.

Pour ma part, ce que je n'aime pas trop dans ce genre de pratique c'est que �a "pollue" les noms de symboles, et je trouve tellement confortable de pouvoir r�utiliser une m�me variable pour accueillir deux objets de type diff�rents au fil des instructions... A�e, pas taper !

[kernelfailure]

�a sert � quoi d'�conomiser 2 caract�res pour sacrifier la lisibilit� ?

Arf... On peut se poser la question.
C'est parce qu'hongrois que c'est mieux
Mais attention � l'exc�s inverse, o� les noms sont des romans.

"instanceUser" L'utilisateur-instance ? L'utilisateur de l'instance ?

Tout simplement une instance de la classe User

Pour ma part, ce que je n'aime pas trop dans ce genre de pratique c'est que �a "pollue" les noms de symboles, et je trouve tellement confortable de pouvoir r�utiliser une m�me variable pour accueillir deux objets de type diff�rents au fil des instructions... A�e, pas taper !

M�me pas besoin de caster en plus ! La mega classe !!!
C'est un confort que j'emploie tr�s souvent lorsque la port�e est locale et/ou la dur�e de vie est courte.
Mixed est un type tr�s puissant. Le polymorphisme absolu : Tout est Object.

[Oscar Hiboux]

M�me pas besoin de caster en plus ! La mega classe !!!

Ahahah, trop la classe, oui !!

Bien d'accord avec le reste aussi, c'est exactement ce que je fais. ^^

[Gruik]

Hello,

A un moment, j'ai pas mal utilis� http://www.jslint.com/ , �a a influenc� mon style d'aujourd'hui.

Aussi, je voulais � cette meme �poque avoir 0 warning firefox en mode strict (mais c'est plus vraiment possible vu que j'utilise tout le temps jQuery, qui en contient pas mal).

Donc la technique que j'utilisais et que j'utilise encore pour tester si une propri�t� existe est :

Code :

S�lectionner tout - Visualiser dans une fen�tre � part

typeof objet['propriete'] != 'undefined'

Sinon mon style est globalement celui de Java.. Notamment mixedCase pour tous les identificateurs.

Je plussoie ce qui a �t� dit pour "var" : faut toujours d�clarer ses variables. En dehors de toute fonction par contre, je d�clare pas de variable, j'utilise les propri�t�s de window (ce qui est globalement la m�me chose mais bon).

Pour la construction d'objets (notation JSON), je mets toujours le nom de la propri�t� entre quotes

Code :

S�lectionner tout - Visualiser dans une fen�tre � part

{ 'prop': 34, 'prop2': 'val' }

Sans parler du style du code, il ya une bonne pratique adopt�e par presque tous qui consiste � ne pas creer de gestionnaires d'�venements avec les attributs html (ex : <a onclick="...">), toujours les attacher indirectement (exemple : quand le DOM est pr�t)

[Sunchaser]

Bonjour,

Je me permets d'intervenir (dans ce post que je suis - du verbe suivre �videment - avec attention), non pas pour une recette particuli�re ou "magique" a appliquer mais pour une question ...
En remontant vers la page 2 ou 3, on y parlais de test de performance entre des boucles for / while (cf le post de franculo_caoulene et son id�e d' "imax" que j'ai adopt�, merci); je me disais donc "y a t il qqchose de particulier a propos du switch" ? Je suis gourmand en switch mais je me demandais si lui n'�tait pas "gourmand" et/ou si il n'y avais rien de particulier a son sujet chez javascript.
Cette question est peut �tre niaise, mais sait on jamais ...

Ca ne va pas faire avancer le schmilblick, mais je ne peut m'emp�cher de m'�tonner lorsque je vois toutes les recommandations: par ex, je connais un syst�me extr�mement on�reux (et pas vieux) dont le javascript de l'interface web a gard� ses petits "document.write", "innerHTML=...", et autres "<a onclick=...>".
Ca m'�pate.

Merci d'avance,

[Causa Sui]

Moi, personellement, mes recomandations sont simples :

1. Ne pas faire de JavaScript (le Javascript c'est mal).
2. Utiliser JQuery.
3. Sinon, tout � d�j� �t� dit : ne JAMAIS inclure le code JS dans l'HTML (non, non, jamais, sinon vous finirez en enfer), utiliser les gestionnaires d'�v�nement modernes (et pas ces monstruosit�s de onXXX), d�finir les variables, utiliser le DOM (ou mieux : E4X), etc.
4. Et le plus important - je ne sais pas si �a a d�j� �t� cit� : ne jamais faire reposer une fonctionnalit� uniquement sur JS, et toujours pr�voir une d�gradabilit� du code (sauf dans certains cas de site clairement orient�s applications).

[RomainVALERI]

[*]Ne pas faire de JavaScript (le Javascript c'est mal).

?!
Je ne parviens pas � deviner � quoi tu fais r�f�rence... quel est le probl�me avec JS ?
Tu peux... *d�velopper* s'il te plait ?
(quitte � cr�er un nouveau thread pour ne pas "troller" sur celui-ci, au th�me l�g�rement diff�rent et d�j� bien charg� ^^)

[Bovino]

1. Ne pas faire de JavaScript (le Javascript c'est mal).
2. Utiliser JQuery.

Comment tu peux utiliser jQuery sans faire de JavaScript

[Causa Sui]

Le Javascript est un langage tr�s �nervant parce que tr�s en dessous de ce qu'il pourrait �tre. Le jour o� on sera au m�me niveau avec JS qu'avec l'ActionScipt (E3X par d�faut, gestions des �v�nements unique, gestion des erreurs unifi�es, possibilit� d'utiliser un typage plus fort etc.) ce sera vraiment plaisant � utiliser.
Donc, j'aimerais ne pas devoir faire du JS tel qu'il est maintenant, mais si j'en fait... c'est avec JQuery !

[Oscar Hiboux]

Bah... c'est presque hors sujet ton affaire. On n'est pas la pour faire de la pub suppl�mentaire � J. Resig... ^^'

E4X c'est bien marrant mais question clart� on a connu mieux. Soit dit en passant, tant qu'on parle de bonnes pratiques : quant il s'agit de manipuler des donn�es autant utiliser JSON, c'est un chou�a plus facile et performant (!). Sauf cas de scripting du c�t� serveur (Jaxer & co.) on peut quand m�me se passer d'XML du c�t� client...

JavaScript est tr�s plaisant, sisi, mais m�me si c'est une question de go�t tu risques quand m�me le lancer de tomates pourries en venant le dire ici...
Sinon, pouvoir utiliser un typage un peu plus fort comme en ActionScript �a serait bien chouette, en effet.

C'est quoi la "gestion des �v�nements unique" ?

[Causa Sui]

C'est ne pas devoir se prendre la t�te avec addEventListener et attachEvent, notamment.
Enfin, moi si je r�le sur JS c'est surtout parce qu'un certain navigateur d'une certaine marque dont je ne citerai pas le nom (je vais pas lui faire de la pub en plus) qui trouve que � le javascript ce n'est pas le plus important � bloque l'�volution de ce langage � un stade anti-diluvien...
(et quand je dis JQuery, c'est �galement valable pour tous les framework de qualit� qui facilitent la vie des d�veloppeurs, je ne suis pas sectaire, mais c'est celui que j'utilise le plus).

[SpaceFrog]

Comment tu peux utiliser jQuery sans faire de JavaScript

internet c'est le mal

[Oscar Hiboux]

C'est ne pas devoir se prendre la t�te avec addEventListener et attachEvent, notamment.

Hmm, et tu proc�des comment alors ? addEventListener & co. (mieux vaut utiliser un framework pour la gestion des �v�nements, en effet) c'est en plein le concept d'observateur, je vois mal comment on pourrait l'�viter. Il faut quand m�me bien l'indiquer quand tu veux suivre les �v�nements sur un sujet donn�. L'ordinateur n'est pas devin non plus...
Et donc, si ce n'est pas �a, c'est quoi ?

Enfin, moi si je r�le sur JS c'est surtout parce qu'un certain navigateur [...] qui trouve que � le javascript ce n'est pas le plus important � bloque l'�volution de ce langage � un stade anti-diluvien...

Question de plateforme alors, pas de langage ! Mais c'est vrai, c'est tr�s frustrant par moment... La lueur � l'horizon c'est que si Microsoft ne se r�veille pas rapidement ils vont se prendre une m�chante claque dans les prochaines ann�es - j'esp�re.


P.S. : un "stade anti-diluvien", c'est un abri anti-d�luge ? ^^

[pserru]

Bonjour,

Un des probl�me classique est la pr�sence de code de d�boguage dans la version en production. Ceci est vrai pour bien des langages, bien qu'en JavaScript... Je sugg�re de n'utiliser la premi�re colonne que pour du commentaire** ou ce type de code. Ceci permet un rep�rage rapide pour le d�veloppeur, et une d�tection facile pour votre logiciel de compactage/installation sur site de production.

** Et encore! Acceptable parce que vous voulez passer en commentaire votre ligne de code de d�boguage.

Bon courage,
Patrick