Question

Nous avons un CMS construit sur Java et Mozilla Rhino pour le serveur JS. Pour le moment, la base de code JS est petite mais en croissance. Avant qu'il ne soit trop tard et que le code soit devenu un désordre épouvantable, je souhaite vous présenter quelques bonnes pratiques et un style de codage.

Évidemment, le contrôle de l’espace de nommage est assez important. Mais qu'en est-il des autres meilleures pratiques, en particulier pour les programmeurs Java?

Était-ce utile?

La solution

Voici quelques conseils des lignes de front:

  • Comme Java, utilisez des docblocks dans le style Doxygen / JsDoc pour les fonctions
  • Test unitaire. Personnellement, comme JsTestDriver, car il peut également être exécuté automatiquement à partir du serveur CI.
  • Utilisez JSLint. Il va chercher à propos du mauvais code
  • Pensez à utiliser le compilateur Google Closure. Il va chercher un code similaire à JSLint, mais cela peut être utile pour repérer des blocs de documentation médiocres, etc.
  • Assurez-vous que tous les membres de votre équipe comprennent le fonctionnement des fermetures. Sinon, cela entraînera des maux de tête
  • Comme vous le dites, les espaces de noms sont importants, en particulier si vous voulez que votre code fonctionne correctement avec d'autres bibliothèques JS ( var myns = myns || {}; )
  • Personnellement, je trouve utile d’utiliser une bibliothèque fournissant des aides OOP telles que des cours, etc. Vous pouvez utiliser l'héritage prototype, mais c'est souvent un peu plus compliqué.

Autres conseils

Je regarderais CommonJS (anciennement ServerJS). C'est vraiment un travail en cours, mais ils ont un système de module standardisé avec plusieurs implémentations. Certaines bibliothèques utiles écrites dans les spécifications CommonJS, telles que Narwhal .

Comme le dit Douglas Crockford, JavaScript est le langage de programmation le plus mal compris du monde. Bien que beaucoup de gens l'ignorent, il existe une méthode right pour coder en JavaScript. Je ne doute pas que si vous laissez les développeurs Java commencer à coder avant de comprendre comment écrire du bon code JavaScript, vous rencontrerez de sérieux problèmes.

La première chose à faire serait de vous assurer que tout le monde a lu l'excellent article de Mozilla, Une réintroduction de JavaScript ( https://developer.mozilla.org/en/a_re-introduction_to_javascript ). L’un des plus gros problèmes de JavaScript est qu’il existe de nombreuses façons de réaliser les tâches les plus courantes, et cet article devrait amener les utilisateurs à se retrouver sur la même page. Les travaux de Douglas Crockford, dont JavaScript: The Good Parts, constituent une autre référence essentielle.

Une autre chose qui attire beaucoup de programmeurs Java / C ++ est que JavaScript utilise la portée function , PAS la portée block. Cela peut causer des problèmes très délicats. Vous trouverez un article intéressant sur ce problème sur A List Apart intitulé Binding in JavaScript.


Pour résumer les principaux problèmes évoqués dans les ressources ci-dessus, les différences les plus cruciales à apprendre sont

  • comment écrire du code orienté objet en utilisant un héritage prototype (vs héritage basé sur une classe)
  • comment utiliser les fermetures et les lambdas
  • comment utiliser la puissance des objets dynamiques
  • comment écrire du code à portée de fonction

Puisque vous avez un moteur JS en Java, prenez l'habitude d'écrire des tests unitaires pour votre code JS. Sélectionnez un style de code et appliquez-le vigoureusement. Si possible, utilisez des outils pour vérifier que le code est soumis au style de codage.

Vous trouverez ci-dessous quelques liens susceptibles de vous aider:

Meilleures pratiques pour Javascript

fichier pdf Best Best Practices JavaScript

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top