IdentifiantMot de passe
Loading...
Mot de passe oublié ?Je m'inscris ! (gratuit)
Navigation

Inscrivez-vous gratuitement
pour pouvoir participer, suivre les réponses en temps réel, voter pour les messages, poser vos propres questions et recevoir la newsletter

Contributions JavaScript / AJAX Discussion :

Etablir un coding style


Sujet :

Contributions JavaScript / AJAX

  1. #1
    Membre émérite
    Avatar de Kaamo
    Homme Profil pro
    Ingénieur développement logiciels
    Inscrit en
    Avril 2007
    Messages
    1 165
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 37
    Localisation : France, Bouches du Rhône (Provence Alpes Côte d'Azur)

    Informations professionnelles :
    Activité : Ingénieur développement logiciels
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Avril 2007
    Messages : 1 165
    Points : 2 778
    Points
    2 778
    Par défaut Etablir un coding style
    Je m'aperçois qu'il n'y a pas vraiment de "coding style" établi pour rédiger du code pour l'univers developpez.net.

    On a tous notre propre style, ce qui fait que, par exemple, les Q/R sont assez éclectiques.

    Parfois la virgule est avant pour lister les éléments d'un tableau/objet.
    L'accolade post-fonction est tantôt à la ligne, tantôt sur la même ligne.
    Etc ...

    Autant de petit détails qui pourraient perturber le débutant, je pense.

    Le dernier relecteur/validateur de code proposé doit-il ré-écrire le code ? Pourquoi ne pas établir un style de code afin que chaque Q/R soit homogène ?

    Des liens utiles :
    Addy Osmani - Style Guides and Beautifiers
    Styles populaires sur Github
    Un merveilleux outil qui permet d'établir un "coding style"

  2. #2
    Expert éminent sénior

    Avatar de vermine
    Profil pro
    Inscrit en
    Mars 2008
    Messages
    6 582
    Détails du profil
    Informations personnelles :
    Âge : 39
    Localisation : Belgique

    Informations forums :
    Inscription : Mars 2008
    Messages : 6 582
    Points : 79 912
    Points
    79 912
    Par défaut
    Ce serait l'idéal de présenter une seule façon de faire. Mais laquelle ?
    Les rédacteurs ne sont pas toujours d'accord.

  3. #3
    Rédacteur

    Avatar de Bovino
    Homme Profil pro
    Développeur Web
    Inscrit en
    Juin 2008
    Messages
    23 647
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 53
    Localisation : France, Gironde (Aquitaine)

    Informations professionnelles :
    Activité : Développeur Web
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Juin 2008
    Messages : 23 647
    Points : 91 220
    Points
    91 220
    Billets dans le blog
    20
    Par défaut
    Je suis d'accord avec Xavier, ce serait bien, mais pour convaincre tout le monde d'un style unique à utiliser... c'est autre chose.

    Mais ça me fait penser à ça : http://jsstyle.github.io/.
    Peut-être pourrions-nous faire un truc en rapport ?
    Par exemple, proposer d'inclure ce badge dans le profil.
    Enfin... il faudra quand même convaincre les admins !
    Pas de question technique par MP !
    Tout le monde peut participer à developpez.com, vous avez une idée, contactez-moi !
    Mes formations video2brain : La formation complète sur JavaScriptJavaScript et le DOM par la pratiquePHP 5 et MySQL : les fondamentaux
    Mon livre sur jQuery
    Module Firefox / Chrome d'intégration de JSFiddle et CodePen sur le forum

  4. #4
    Modérateur

    Avatar de NoSmoking
    Homme Profil pro
    Inscrit en
    Janvier 2011
    Messages
    16 959
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Localisation : France, Isère (Rhône Alpes)

    Informations forums :
    Inscription : Janvier 2011
    Messages : 16 959
    Points : 44 112
    Points
    44 112
    Par défaut

    mais qui sont ces gens qui veulent changer nos habitudes

    On en avait parler à l'occasion de cette remise à jour des FAQ pour mémoire.

    Perso quand je dois ré-indenter du code illisible j'utilise Online JavaScript beautifier .

    J'ai beaucoup de mal à me situer suivant Popular Coding Convention on Github

  5. #5
    Membre émérite
    Avatar de Kaamo
    Homme Profil pro
    Ingénieur développement logiciels
    Inscrit en
    Avril 2007
    Messages
    1 165
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 37
    Localisation : France, Bouches du Rhône (Provence Alpes Côte d'Azur)

    Informations professionnelles :
    Activité : Ingénieur développement logiciels
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Avril 2007
    Messages : 1 165
    Points : 2 778
    Points
    2 778
    Par défaut
    Merci de vos réponses.
    On en avait parler à l'occasion de cette remise à jour des FAQ pour mémoire.
    Cette discussion est exactement le reflet de ce que je pensais. Au delà d'uniformiser les codes, cela permet également aux novices d'apprendre une bonne syntaxe en leur inculquant les bonnes pratiques.
    Bon style de code = moins d'erreur classique.

    Mais c'est vrai que chacun a son style pour coder, je pense que ça serait utopique de forcer les rédacteurs à arborer un style prédéfini. Le but n'est pas de rebuter

    Sympa le badge Bovino, je ne connaissais pas celui là ! Pourquoi pas en effet ce genre de signature, mais je crois que NoSmoking a trouvé une bonne solution avec JS beautifier.

    Un outil qui prend du code en entrée, et le ré-arrange en "style developpez.net".

  6. #6
    Expert éminent sénior

    Avatar de vermine
    Profil pro
    Inscrit en
    Mars 2008
    Messages
    6 582
    Détails du profil
    Informations personnelles :
    Âge : 39
    Localisation : Belgique

    Informations forums :
    Inscription : Mars 2008
    Messages : 6 582
    Points : 79 912
    Points
    79 912
    Par défaut
    Idée à proposer à l'ensemble de l'équipe de Developpez.

  7. #7
    Expert éminent sénior
    Avatar de Auteur
    Profil pro
    Inscrit en
    Avril 2004
    Messages
    7 648
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations forums :
    Inscription : Avril 2004
    Messages : 7 648
    Points : 11 137
    Points
    11 137
    Par défaut
    Citation Envoyé par Kaamo Voir le message
    mais je crois que NoSmoking a trouvé une bonne solution avec JS beautifier.
    pour avoir testé rapidement l'outil, le résultat ne me convient pas pour autant
    Rien que pour les accolades ouvrantes, je préfère les avoir à la ligne

  8. #8
    Membre émérite
    Avatar de Kaamo
    Homme Profil pro
    Ingénieur développement logiciels
    Inscrit en
    Avril 2007
    Messages
    1 165
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 37
    Localisation : France, Bouches du Rhône (Provence Alpes Côte d'Azur)

    Informations professionnelles :
    Activité : Ingénieur développement logiciels
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : Avril 2007
    Messages : 1 165
    Points : 2 778
    Points
    2 778
    Par défaut
    JSBeautifer est configurable. Donc avec les bonnes options, on peut mettre des accolades, ne pas en mettre, les mettre à la ligne etc ... (peut-être pas sur la version web par contre)

    Rien que pour les accolades ouvrantes, je préfère les avoir à la ligne
    Et moi sur la même ligne C'est un choix, il ne faut pas aller contre ça. Comme je l'ai dit il ne faut pas nous rebuter à faire du code pour DVP.

    Mais ... pourquoi pas automatiser le process et passer une sorte d'outil qui formate un code vers un code dvp (comprendre accessible/compréhensible aux débutants)

  9. #9
    Modérateur

    Avatar de NoSmoking
    Homme Profil pro
    Inscrit en
    Janvier 2011
    Messages
    16 959
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Localisation : France, Isère (Rhône Alpes)

    Informations forums :
    Inscription : Janvier 2011
    Messages : 16 959
    Points : 44 112
    Points
    44 112
    Par défaut
    Citation Envoyé par Auteur
    Rien que pour les accolades ouvrantes, je préfère les avoir à la ligne
    l'option -> Braces on own line est faite pour toi!

  10. #10
    Expert éminent sénior
    Avatar de Auteur
    Profil pro
    Inscrit en
    Avril 2004
    Messages
    7 648
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations forums :
    Inscription : Avril 2004
    Messages : 7 648
    Points : 11 137
    Points
    11 137
    Par défaut
    Citation Envoyé par NoSmoking Voir le message
    l'option -> Braces on own line est faite pour toi!
    super

  11. #11
    Rédacteur/Modérateur

    Avatar de SylvainPV
    Profil pro
    Inscrit en
    Novembre 2012
    Messages
    3 375
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations forums :
    Inscription : Novembre 2012
    Messages : 3 375
    Points : 9 944
    Points
    9 944
    Par défaut
    Hé hé je me souviens de grands débats à la pause café pour savoir s'il fallait mettre les accolades ouvrantes en bout de ligne ou en nouvelle ligne. Le style, comme son nom l'indique, c'est quelque-chose d'assez subjectif. Je ne pense pas que ce soit une bonne idée de "forcer la main" aux contributeurs avec un style très strict. On peut faire quelques petites choses comme les conventions de nommage ou l'utilisation d'espaces au lieu de tabulations, mais pour le reste ça devient un mini-débat à chaque fois.

    Tiens par exemple :
    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    3
    var a=1;
    var b=2;
    var c=3;
    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    3
    var a=1
       , b=2
       , c=3;
    Une petite escarmouche entre collègues peut vite finir en déclaration de guerre ! Combien de développeurs ont péri sous le feu des commits ravageurs et des jets de stylos d'un bout à l'autre de la pièce...
    One Web to rule them all

Discussions similaires

  1. equals code style
    Par bugz57 dans le forum Général Java
    Réponses: 2
    Dernier message: 22/10/2012, 22h11
  2. Visual Studio & Coding Style
    Par Faiche dans le forum Visual C++
    Réponses: 2
    Dernier message: 24/10/2007, 12h14
  3. [TChart] Comment changeer le style par code ?
    Par obione dans le forum Composants VCL
    Réponses: 3
    Dernier message: 09/12/2005, 16h52
  4. changer style ou class par le code
    Par genetechno dans le forum Général JavaScript
    Réponses: 2
    Dernier message: 08/07/2005, 10h12

Partager

Partager
  • Envoyer la discussion sur Viadeo
  • Envoyer la discussion sur Twitter
  • Envoyer la discussion sur Google
  • Envoyer la discussion sur Facebook
  • Envoyer la discussion sur Digg
  • Envoyer la discussion sur Delicious
  • Envoyer la discussion sur MySpace
  • Envoyer la discussion sur Yahoo