diff options
Diffstat (limited to 'files/fr/mdn/guidelines/code_guidelines')
6 files changed, 1146 insertions, 35 deletions
diff --git a/files/fr/mdn/guidelines/code_guidelines/css/index.html b/files/fr/mdn/guidelines/code_guidelines/css/index.html new file mode 100644 index 0000000000..bffb68aad4 --- /dev/null +++ b/files/fr/mdn/guidelines/code_guidelines/css/index.html @@ -0,0 +1,255 @@ +--- +title: Lignes directrices du CSS +slug: MDN/Guidelines/Code_guidelines/CSS +tags: + - CSS + - Code + - Guide + - Directives + - MDN Meta +translation_of: MDN/Guidelines/Code_guidelines/CSS +--- +<div>{{MDNSidebar}}</div> + +<p class="summary seoSummary">Les directives suivantes couvrent la manière d'écrire les CSS pour les exemples de code MDN.</p> + +<h2 id="In_this_article">Dans cet article</h2> + +<ul> + <li><a href="#high-level_guidelines">Lignes directrices de haut niveau</a> + + <ul> + <li><a href="#dont_use_preprocessors">N'utilisez pas de préprocesseurs</a></li> + <li><a href="#dont_use_specific_css_methodologies">N'utilisez pas de méthodologies CSS spécifiques</a></li> + <li><a href="#use_flexiblerelative_units">Utiliser des unités flexibles/relatives</a></li> + <li><a href="#dont_use_resets">Ne pas utiliser de réinitialisation</a></li> + <li><a href="#plan_your_css_%e2%80%94_avoid_overriding">Planifiez votre CSS — évitez les surcharges</a></li> + </ul> + </li> + <li><a href="#general_css_coding_style">Style général de codage CSS</a> + <ul> + <li><a href="#use_expanded_syntax">Utiliser une syntaxe étendue</a></li> + <li><a href="#favor_longhand_rules_over_terse_shorthand">Privilégiez les règles longues aux règles raccourcies</a></li> + <li><a href="#use_double_quotes_around_values">Utilisez des guillemets doubles autour des valeurs</a></li> + <li><a href="#spacing_around_function_parameters">Espacement autour des paramètres de la fonction</a></li> + <li><a href="#css_comments">Commentaires CSS</a></li> + <li><a href="#dont_use_!important">Ne pas utiliser !important</a></li> + </ul> + </li> + <li><a href="#specific_css_syntax_points">Points de syntaxe CSS spécifiques</a> + <ul> + <li><a href="#turning_off_borders_and_other_properties">Désactiver les bordures et autres propriétés</a></li> + <li><a href="#use_mobile_first_media_queries">Utilisez des requêtes média "mobile first"</a></li> + </ul> + </li> + <li><a href="#selectors">Sélecteurs</a> + <ul> + <li><a href="#dont_use_id_selectors">N'utilisez pas de sélecteurs ID</a></li> + <li><a href="#put_multiple_selectors_on_separate_lines">Mettre les sélecteurs multiples sur des lignes séparées</a></li> + </ul> + </li> +</ul> + +<h2 id="High-level_guidelines">Lignes directrices de haut niveau</h2> + +<h3 id="Dont_use_preprocessors">N'utilisez pas de préprocesseurs</h3> + +<p>N'utilisez pas la syntaxe des préprocesseurs, ex. <a href="https://sass-lang.com/">Sass</a>, <a href="http://lesscss.org/">Less</a>, ou <a href="http://stylus-lang.com/">Stylus,</a> dans votre code d'exemple MDN. MDN documente le langage CSS classique, et l'utilisation de préprocesseurs ne sert qu'à élever la barre pour comprendre les exemples, ce qui peut potentiellement perdre les lecteurs.</p> + +<h3 id="Dont_use_specific_CSS_methodologies">N'utilisez pas de méthodologies CSS spécifiques</h3> + +<p>Dans le même esprit que la directive précédente, n'écrivez pas de code d'exemple MDN en utilisant une méthodologie CSS spécifique telle que <a href="http://getbem.com/naming/">BEM</a> ou <a href="https://smacss.com/">SMACSS</a>. Même s'il s'agit de syntaxe CSS valide, les conventions de dénomination peuvent prêter à confusion pour les personnes qui ne sont pas familières avec ces méthodologies.</p> + +<h3 id="Use_flexiblerelative_units">Utiliser des unités flexibles/relatives</h3> + +<p>Pour une flexibilité maximale sur le plus grand nombre possible d'appareils, il est judicieux de dimensionner les conteneurs, le <code>padding</code>, etc. en utilisant des unités relatives comme les <code>em</code> et les <code>rem</code>, ou des pourcentages et des unités de « viewport » si vous souhaitez qu'ils varient en fonction de la largeur du « viewport ». Vous pouvez en savoir plus à ce sujet dans notre article <a href="/fr/docs/Web/Progressive_web_apps/Responsive/responsive_design_building_blocks#fluid_grids">Éléments de construction d'un design adaptatif (Responsive Design)</a>.</p> + +<h3 id="Dont_use_resets">Ne pas utiliser de réinitialisation</h3> + +<p>Pour un contrôle maximal des CSS sur toutes les plates-formes, beaucoup de gens avaient l'habitude d'utiliser les réinitialisations CSS pour supprimer tous les styles, avant de reconstruire les choses eux-mêmes. Cette méthode a certainement ses mérites, mais surtout dans le monde moderne, les réinitialisations CSS peuvent être excessives et entraîner beaucoup de temps supplémentaire passé à réimplémenter des choses qui n'étaient pas complètement cassées au départ, comme les marges par défaut, les styles de liste, etc.</p> + +<p>Si vous avez vraiment envie d'utiliser une réinitialisation, envisagez d'utiliser <a href="https://necolas.github.io/normalize.css/">normalize.css de Nicolas Gallagher</a>, qui vise simplement à rendre les choses plus cohérentes d'un navigateur à l'autre, à se débarrasser de certains désagréments par défaut que nous supprimons toujours (les marges sur <code><body></code>, par exemple) et à corriger quelques bogues.</p> + +<h3 id="Plan_your_CSS_—_avoid_overriding">Planifiez votre CSS — évitez les surcharges</h3> + +<p>Avant de vous lancer dans l'écriture de gros morceaux de CSS, planifiez soigneusement vos styles. Quels styles généraux seront nécessaires, quelles mises en page différentes devrez-vous créer, quelles redéfinitions spécifiques devront être créées et seront-elles réutilisables ? Par-dessus tout, vous devez essayer d'éviter de créer trop de redéfinitions. Si vous vous retrouvez constamment en train d'écrire des styles pour ensuite les annuler quelques règles plus bas, vous devez probablement repenser votre stratégie.</p> + +<h2 id="General_CSS_coding_style">Style général de codage CSS</h2> + +<h3 id="Use_expanded_syntax">Utiliser une syntaxe étendue</h3> + +<p>Vous pouvez utiliser différents styles d'écriture CSS, mais nous préférons le style étendu, avec le sélecteur/l'accolade ouvrante, l'accolade fermante et chaque déclaration sur une ligne distincte. Cela optimise la lisibilité et favorise la cohérence sur le MDN.</p> + +<p>Utilisez ceci :</p> + +<pre class="brush: css example-good">p { + color: white; + background-color: black; + padding: 1rem; +}</pre> + +<p>Pas cela :</p> + +<pre class="brush: css example-bad">p { color: white; background-color: black; padding: 1rem; }</pre> + +<p>En outre, gardez ces spécificités à l'esprit :</p> + +<ul> + <li>Insérez un espace entre le(s) sélecteur(s) et l'accolade ouvrante.</li> + <li>Incluez toujours un point-virgule à la fin de la dernière déclaration, même si ce n'est pas strictement nécessaire.</li> + <li>Mettez l'accolade de fermeture sur une nouvelle ligne.</li> + <li>Dans chaque déclaration, mettez un espace après les deux points de séparation, mais pas avant.</li> + <li>Utilisez 2 espaces pour l'indentation du code.</li> +</ul> + +<h3 id="Favor_longhand_rules_over_terse_shorthand">Privilégiez les règles longues aux règles raccourcies</h3> + +<p>En général, lorsque vous enseignez les spécificités de la syntaxe CSS, il est plus clair et plus évident d'utiliser des propriétés longues plutôt que des raccourcies (à moins bien sûr que l'enseignement du raccourci ne soit le but de l'exemple). N'oubliez pas que les exemples du MDN ont pour but d'enseigner aux gens, et non d'être efficaces ou astucieuses.</p> + +<p>Tout d'abord, il est souvent plus difficile de comprendre ce que fait le raccourci. Il faut un certain temps pour comprendre exactement ce que fait la syntaxe <a href="/fr/docs/Web/CSS/font"><code>font</code></a>, par exemple :</p> + +<pre class="brush: css">font: small-caps bold 2rem/1.5 sans-serif;</pre> + +<p>Alors que celle-ci est plus immédiate en termes de compréhension :</p> + +<pre class="brush: css">font-variant: small-caps; +font-weight: bold; +font-size: 2rem; +line-height: 1.5; +font-family: sans-serif;</pre> + +<p>Deuxièmement, les raccourcis CSS comportent des pièges potentiels supplémentaires : des valeurs par défaut sont définies pour des parties de la syntaxe que vous n'avez pas explicitement définies, ce qui peut produire des réinitialisations inattendues des valeurs que vous avez définies plus tôt dans la cascade, ou d'autres effets attendus. Par exemple, la propriété <a href="/fr/docs/Web/CSS/grid"><code>grid</code></a> définit toutes les valeurs par défaut suivantes pour les éléments qui ne sont pas spécifiés :</p> + +<ul> + <li><a href="/fr/docs/Web/CSS/grid-template-rows"><code>grid-template-rows</code></a>: <code>none</code></li> + <li><a href="/fr/docs/Web/CSS/grid-template-columns"><code>grid-template-columns</code></a>: <code>none</code></li> + <li><a href="/fr/docs/Web/CSS/grid-template-areas"><code>grid-template-areas</code></a>: <code>none</code></li> + <li><a href="/fr/docs/Web/CSS/grid-auto-rows"><code>grid-auto-rows</code></a>: <code>auto</code></li> + <li><a href="/fr/docs/Web/CSS/grid-auto-columns"><code>grid-auto-columns</code></a>: <code>auto</code></li> + <li><a href="/fr/docs/Web/CSS/grid-auto-flow"><code>grid-auto-flow</code></a>: <code>row</code></li> + <li><a href="/fr/docs/Web/CSS/column-gap"><code>column-gap</code></a>: <code>0</code></li> + <li><a href="/fr/docs/Web/CSS/row-gap"><code>row-gap</code></a>: <code>0</code></li> + <li><a href="/fr/docs/Web/CSS/column-gap"><code>column-gap</code></a>: <code>normal</code></li> + <li><a href="/fr/docs/Web/CSS/row-gap"><code>row-gap</code></a>: <code>normal</code></li> +</ul> + +<p>En outre, certains raccourcis ne fonctionnent comme prévu que si vous incluez les différents composants de la valeur dans un certain ordre. Dans les animations CSS, par exemple :</p> + +<pre class="brush: css">/* duration | timing-function | delay | iteration-count + direction | fill-mode | play-state | name */ +animation: 3s ease-in 1s 2 reverse both paused slidein;</pre> + +<p>À titre d'exemple, la première valeur qui peut être analysée comme un <a href="/fr/docs/Web/CSS/time" title="Le type de données CSS <time> ; représente une valeur de temps exprimée en secondes ou en millisecondes. Il est utilisé dans les propriétés d'animation, de transition et autres propriétés connexes."><code><time></code></a> est affecté à la propriété <a href="/fr/docs/Web/CSS/animation-duration" title="La propriété CSS animation-duration définit la durée nécessaire à une animation pour effectuer un cycle. "><code>animation-duration</code></a>, et la seconde est affectée à <a href="/fr/docs/Web/CSS/animation-delay" title="La propriété CSS animation-delay définit le moment où une animation commence. L'animation peut démarrer plus tard, immédiatement dès son début, ou immédiatement et à mi-chemin de l'animation."><code>animation-delay</code></a>. Pour plus de détails, lisez l'intégralité de <a href="/fr/docs/Web/CSS/animation#syntax">syntaxe de l'animation</a>.</p> + +<h3 id="Use_double_quotes_around_values">Utilisez des guillemets doubles autour des valeurs</h3> + +<p>Lorsque des guillemets peuvent ou doivent être inclus, utilisez-les, et utilisez des guillemets doubles. Par exemple :</p> + +<pre class="brush: css example-good">[data-vegetable="liquid"] { + background-color: goldenrod; + background-image: url("../../media/examples/lizard.png"); +}</pre> + +<h3 id="Spacing_around_function_parameters">Espacement autour des paramètres de la fonction</h3> + +<p>Les paramètres des fonctions doivent comporter des espaces après les virgules de séparation, mais pas avant :</p> + +<pre class="brush: css example-good">color: rgb(255, 0, 0); +background-image: linear-gradient(to bottom, red, black);</pre> + +<h3 id="CSS_comments">Commentaires CSS</h3> + +<p>Utilisez des commentaires de style CSS pour commenter le code qui n'est pas auto-documenté :</p> + +<pre class="brush: css example-good">/* Il s'agit d'un commentaire de style CSS */</pre> + +<p>Mettez vos commentaires sur des lignes séparées précédant le code auquel ils se réfèrent :</p> + +<pre class="brush: css example-good">h3 { + /* Crée une ombre portée rouge, décalée de 1px vers la droite et le bas, avec un rayon de flou de 2px. */ + text-shadow: 1px 1px 2px red; + /* Définit la taille de la police au double de la taille de la police du document par défaut. */ + font-size: 2rem; +}</pre> + +<p>Notez également que vous devez laisser un espace entre les astérisques et le commentaire, dans chaque cas.</p> + +<h3 id="Dont_use_!important">Ne pas utiliser !important</h3> + +<p><code>!important</code> est un dernier recours généralement utilisé uniquement lorsque vous devez remplacer quelque chose et qu'il n'y a pas d'autre moyen. Il s'agit d'une mauvaise pratique que vous devez éviter dans la mesure du possible.</p> + +<p>Mauvais usage :</p> + +<pre class="brush: css example-bad">.bad-code { + font-size: 4rem !important; +}</pre> + +<h2 id="Specific_CSS_syntax_points">Points de syntaxe CSS spécifiques</h2> + +<h3 id="Turning_off_borders_and_other_properties">Désactiver les bordures et autres propriétés</h3> + +<p>Lorsque vous désactivez les bordures (et toute autre propriété qui peut prendre <code>0</code> ou <code>none</code> comme valeurs), utilisez <code>0</code> plutôt que <code>none</code> :</p> + +<pre class="brush: css example-good">border: 0;</pre> + +<h3 id="Use_mobile_first_media_queries">Utilisez des requêtes média "mobile first"</h3> + +<p>Lorsque vous incluez différents ensembles de styles pour différentes tailles de fenêtres d'affichage à l'aide de requêtes de médias dans la même feuille de style, il est judicieux de faire en sorte que le style par défaut avant l'application de toute requête de médias au document soit le style pour écran étroit/mobile, puis de le remplacer pour les fenêtres d'affichage plus larges dans des requêtes de médias successives.</p> + +<pre class="brush: css example-good">/* Mise en page CSS par défaut pour les écrans étroits */ + +@media (min-width: 480px) { + /* CSS pour les écrans de largeur moyenne */ +} + +@media (min-width: 800px) { + /* CSS pour les écrans larges */ +} + +@media (min-width: 1100px) { + /* CSS pour les écrans très larges */ +}</pre> + +<p>Cela présente de nombreux avantages, exposés dans notre article <a href="/fr/docs/Web/Progressive_web_apps/Responsive/Mobile_first">Priorité aux mobiles</a>.</p> + +<h2 id="Selectors">Sélecteurs</h2> + +<h3 id="Dont_use_ID_selectors">N'utilisez pas de sélecteurs ID</h3> + +<p>Il n'est pas vraiment nécessaire d'utiliser des sélecteurs d'ID - ils sont moins flexibles (vous ne pouvez pas en ajouter d'autres si vous découvrez que vous en avez besoin de plus d'un), et il est plus difficile de les remplacer si nécessaire, car ils sont plus spécifiques que les classes.</p> + +<p>Bonne pratique :</p> + +<pre class="brush: css example-good">.editorial-summary { + ... +}</pre> + +<p>Mauvaise pratique :</p> + +<pre class="brush: css example-bad">#editorial-summary { + ... +}</pre> + +<h3 id="Put_multiple_selectors_on_separate_lines">Mettre les sélecteurs multiples sur des lignes séparées</h3> + +<p>Lorsqu'une règle comporte plusieurs sélecteurs, placez chaque sélecteur sur une nouvelle ligne. La liste des sélecteurs est ainsi plus facile à lire et les lignes de code sont plus courtes.</p> + +<p>Faites ceci :</p> + +<pre class="brush: css example-good">h1, +h2, +h3 { + font-family: sans-serif; + text-align: center; +}</pre> + +<p>Pas ça :</p> + +<pre class="brush: css example-bad">h1, h2, h3 { + font-family: sans-serif; + text-align: center; +}</pre> + +<h2 id="Good_CSS_examples_on_MDN">De bons exemples de CSS sur MDN</h2> + +<p>Vous pouvez trouver de bons extraits CSS concis et significatifs en haut de nos pages de référence des propriétés CSS - parcourez notre <a href="/fr/docs/Web/CSS/Reference#keyword_index">index des mots-clés CSS</a> pour en trouver. Nos exemples interactifs sont généralement écrits pour suivre les directives ci-dessus, mais sachez qu'ils peuvent différer à certains endroits, car ils ont pour la plupart été écrits avant la nouvelle rédaction des directives.</p> diff --git a/files/fr/mdn/guidelines/code_guidelines/general/index.html b/files/fr/mdn/guidelines/code_guidelines/general/index.html new file mode 100644 index 0000000000..c2358c8e2f --- /dev/null +++ b/files/fr/mdn/guidelines/code_guidelines/general/index.html @@ -0,0 +1,167 @@ +--- +title: Lignes directrices générales pour tous les exemples de code +slug: MDN/Guidelines/Code_guidelines/General +tags: + - Code + - General + - Guide + - Directives + - MDN Meta +translation_of: MDN/Guidelines/Code_guidelines/General +--- +<div>{{MDNSidebar}}</div> + +<p class="summary">Les directives suivantes concernant les exemples de code s'appliquent à tout le code, qu'il s'agisse de HTML, de CSS, de JavaScript ou d'autre chose.</p> + +<h2 id="In_this_article">Dans cet article</h2> + +<ul> + <li><a href="#indentation_spacing_size">Indentation, espacement, taille</a> + + <ul> + <li><a href="#indentation">Indentation</a></li> + <li><a href="#code_line_length">Longueur des lignes de code</a></li> + <li><a href="#code_block_height">Hauteur des blocs de code</a></li> + </ul> + </li> + <li><a href="#guidelines_for_displaying_examples">Directives pour l'affichage des exemples</a> + <ul> + <li><a href="#size_of_rendered_example">Taille du rendu des exemples</a></li> + <li><a href="#use_of_images_and_other_media">Utilisation d'images et d'autres médias</a></li> + <li><a href="#use_of_color">Utilisation de la couleur</a></li> + <li><a href="#highlight_good_and_bad_practice_examples">Mettre en évidence les exemples de bonnes et de mauvaises pratiques</a></li> + </ul> + </li> + <li><a href="#writing_syntax_sections_on_reference_pages">Rédaction de sections syntaxiques sur les pages de référence</a></li> +</ul> + +<h2 id="Indentation_spacing_size">Indentation, espacement, taille</h2> + +<h3 id="Indentation">Indentation</h3> + +<p>Tout le code doit utiliser 2 espaces pour l'indentation, par exemple :</p> + +<pre class="brush: html example-good"><div> + <p>C'est mon paragraphe.</p> +</div></pre> + +<pre class="brush: js example-good">function myFunc() { + if(thingy) { + console.log('Ouaip, ça a marché.'); + } +}</pre> + +<h3 id="Code_line_length">Longueur des lignes de code</h3> + +<p>Les lignes de code ne doivent pas comporter plus de 80 caractères (64 pour les <a href="https://github.com/mdn/interactive-examples">exemples interactifs</a>). Vous devez rompre les lignes de manière raisonnable pour des raisons de lisibilité, mais pas au détriment des bonnes pratiques.</p> + +<p>Par exemple, ceci n'est pas génial :</p> + +<pre class="brush: js example-bad">let tommyCat = 'Dit Tommy le chat en reculant pour évacuer tout corps étranger qui aurait pu se loger dans sa puissante gorge. Plus d'un gros rat de gouttière avait trouvé la mort en regardant à bout portant le canon caverneux de cette impressionnante machine à rôder.';</pre> + +<p>C'est mieux, mais un peu gênant :</p> + +<pre class="brush: js">let tommyCat = 'Dit Tommy le chat en reculant pour évacuer tout corps étranger ' ++ 'qui aurait pu se loger dans sa puissante gorge. Plus d’un gros rat de gouttière ' ++ 'avait trouvé la mort en regardant à bout portant le canon caverneux de cette ' ++ 'impressionnante machine à rôder.';</pre> + +<p>Une meilleure solution consiste à utiliser un <i>template</i> :</p> + +<pre class="brush: js example-good">let tommyCat = `Dit Tommy le chat en reculant pour évacuer tout corps étranger + qui aurait pu se loger dans sa puissante gorge. Plus d'un gros rat de gouttière + avait trouvé la mort en regardant à bout portant le canon caverneux de cette + impressionnante machine à rôder.`;</pre> + +<h3 id="Code_block_height">Hauteur des blocs de code</h3> + +<p>Les blocs de code doivent être aussi longs que nécessaire, mais pas plus. L'idéal est de viser quelque chose de court, comme 15 à 25 lignes. Si un bloc de code doit être beaucoup plus long, envisagez de ne montrer que l'extrait le plus utile et de créer un lien vers l'exemple complet sur un repo GitHub ou un CodePen, par exemple.</p> + +<h2 id="Guidelines_for_displaying_examples">Directives pour l'affichage des exemples</h2> + +<h3 id="Size_of_rendered_example">Taille du rendu des exemples</h3> + +<p>Le volet de contenu principal de MDN a une largeur d'environ 700px sur un ordinateur de bureau. Les exemples intégrés à MDN doivent donc avoir une apparence correcte à cette largeur (définissez la largeur des exemples intégrés à 100%).</p> + +<p>En ce qui concerne la hauteur, nous vous recommandons de maintenir l'exemple rendu à moins de 700px de hauteur si possible, pour une lisibilité maximale à l'écran.</p> + +<p>Vous devriez également penser à rendre vos exemples plus ou moins adaptables, afin qu'ils soient également utiles sur les appareils mobiles.</p> + +<h3 id="Use_of_images_and_other_media">Utilisation d'images et d'autres médias</h3> + +<p>Parfois, vous voudrez inclure des images ou d'autres médias dans un exemple. Si vous le faites :</p> + +<ul> + <li>Assurez-vous que leur licence vous permet de les utiliser. Essayez d'utiliser des médias dont la licence est très permissive, comme <a href="https://creativecommons.org/share-your-work/public-domain/cc0/">CC0</a>, ou au moins compatible avec notre licence générale de contenu - <a href="https://creativecommons.org/licenses/by-sa/2.5/">Licence Creative Commons Attribution-ShareAlike</a> (CC-BY-SA).</li> + <li>Pour les images, faites-les passer par <a href="https://tinypng.com">https://tinypng.com</a> ou <a href="https://imageoptim.com">https://imageoptim.com</a>, pour réduire le poids de la page des exemples.</li> + <li>Pour le <code>SVG</code>, exécutez le code via <a href="https://jakearchibald.github.io/svgomg/">SVGOMG</a>, et assurez-vous que le fichier <code>SVG</code> comporte une ligne vide à la fin du fichier.</li> + <li> + <p>Lorsque vous affichez des icônes sur une page (ex. via <a href="/fr/docs/Web/CSS/background-image"><code>background-image</code></a>), utilisez les icônes du référentiel <a href="https://github.com/mdn/mdn-dinocons">mdn-dinocons</a>, le cas échéant, et essayez de correspondre à leur style dans les autres cas.</p> + </li> +</ul> + +<h3 id="Use_of_color">Utilisation de la couleur</h3> + +<p>Minuscule pour l'hexadécimal, peut utiliser des mots-clés pour les nuances et les couleurs primaires (ex. : black, white, red), utiliser des schémas plus complexes uniquement si nécessaire (ex. : pour inclure la transparence).</p> + +<p>Préférez utiliser des mots-clés pour les couleurs primaires et autres couleurs "de base", par exemple :</p> + +<pre class="brush: css example-good"> +color: black; +color: white; +color: red; +</pre> + +<p>Utilisez rgb() pour des couleurs plus complexes (y compris les couleurs semi-transparentes) :</p> + +<pre class="brush: css example-good"> +color: rgb(0, 0, 0, 0.5); +color: rgb(248, 242, 230); +</pre> + +<p>Si vous devez utiliser des couleurs hexadécimales, utilisez des minuscules :</p> + +<pre class="brush: css example-good"> +color: #058ed9; +color: #a39a92; +</pre> + +<p>et utilisez la forme abrégée le cas échéant :</p> + +<pre class="brush: css example-good"> +color: #ff0; +color: #fff; +</pre> + +<p>Le fichier <a href="https://github.com/mdn/mdn-minimalist/blob/main/sass/vars/_color-palette.scss">sass/vars/_color-palette.scss</a> du dépôt <a href="https://github.com/mdn/mdn-minimalist">mdn-minimalist</a> comporte un ensemble de couleurs utiles qui complètent le design général de MDN.</p> + +<h3 id="Highlight_good_and_bad_practice_examples">Mettre en évidence les exemples de bonnes et de mauvaises pratiques</h3> + +<p>Comme vous le remarquerez en parcourant ces lignes directrices, les blocs de code censés être des exemples de bonnes pratiques sont marqués d'un fond en vert, et les blocs de code censés être des exemples de mauvaises pratiques sont marqués d'un fond en rouge.</p> + +<p>Pour ce faire, vous devez d'abord utiliser les commandes de l'éditeur MDN pour placer votre bloc de code dans un bloc <code><pre></code> et lui donner la coloration syntaxique appropriée. La source du code ressemblera à quelque chose comme ceci :</p> + +<pre class="brush: js"> +function myFunc() { + console.log('Hello!'); +}; +</pre> +</pre> + +<p>Pour en faire un bon exemple, vous insérez <code>example-good</code> juste avant le guillemet fermant de l'attribut <code>class</code> :</p> + +<pre class="brush: html"><pre class="brush: js example-good"> + ... +</pre> + +<p>Pour en faire un mauvais exemple, vous insérez <code>example-bad</code> juste avant le guillemet fermant de l'attribut <code>class</code> :</p> + +<pre class="brush: html"><pre class="brush: js example-bad"> + ... +</pre> + +<p>Nous aimerions vous encourager à les utiliser. Il n'est pas nécessaire de les utiliser partout, mais seulement lorsque vous signalez spécifiquement les bonnes et mauvaises pratiques dans votre code.</p> + +<h2 id="Writing_syntax_sections_on_reference_pages">Rédaction de sections syntaxiques sur les pages de référence</h2> + +<p>Les pages de référence MDN comprennent des sections Syntaxe qui indiquent sans ambiguïté quelle peut/doit être la syntaxe d'une fonctionnalité, par exemple une méthode JavaScript, une propriété CSS, un élément HTML, etc. Des directives pour les rédiger sont données sur le document <a href="/fr/docs/MDN/Structures/Syntax_sections">Sections syntaxiques</a>.</p> diff --git a/files/fr/mdn/guidelines/code_guidelines/html/index.html b/files/fr/mdn/guidelines/code_guidelines/html/index.html new file mode 100644 index 0000000000..8ac19e47bf --- /dev/null +++ b/files/fr/mdn/guidelines/code_guidelines/html/index.html @@ -0,0 +1,162 @@ +--- +title: Lignes directrices pour le HTML +slug: MDN/Guidelines/Code_guidelines/HTML +tags: + - Code + - Guide + - Directives + - HTML + - MDN Meta +translation_of: MDN/Guidelines/Code_guidelines/HTML +--- +<div>{{MDNSidebar}}</div> + +<p class="summary">Les directives suivantes couvrent la manière d'écrire du HTML pour les exemples de code MDN.</p> + +<h2 id="In_this_article">Dans cet article</h2> + +<ul> + <li><a href="#doctype_and_metadata">Doctype et méta-données</a> + <ul> + <li><a href="#doctype">Doctype</a></li> + <li><a href="#document_language">Langue du document</a></li> + <li><a href="#document_characterset">Jeu de caractères du document</a></li> + <li><a href="#viewport_meta_tag">Méta-balise Viewport</a></li> + </ul> + </li> + <li><a href="#general_markup_coding_style">Style général de codage des balises</a> + <ul> + <li><a href="#use_lowercase">Utiliser les minuscules</a></li> + <li><a href="#trailing_slashes">Barre oblique de fermeture (slash)</a></li> + <li><a href="#quoting_attributes">Guillemets des attributs</a></li> + <li><a href="#use_double_quotes">Utiliser les guillemets doubles</a></li> + <li><a href="#boolean_attributes">Attributs booléens</a></li> + <li><a href="#class_and_id_names">Noms de classes et d'ID</a></li> + <li><a href="#entity_references">Références des entités</a></li> + </ul> + </li> +</ul> + +<h2 id="Doctype_and_metadata">Doctype et méta-données</h2> + +<div class="notecard note"> +<p><strong>Note :</strong> Les directives de cette section ne s'appliquent que lorsque vous devez montrer un document HTML complet. La plupart du temps, vous n'aurez pas besoin de le faire ; un extrait est généralement suffisant pour démontrer une fonctionnalité. Lorsque vous utilisez la macro <a href="/fr/docs/MDN/Structures/Code_examples#traditional_live_samples">EmbedLiveSample</a>, il suffit d'inclure l'extrait HTML ; il sera automatiquement inséré dans un document HTML complet lors de son affichage.</p> +</div> + +<h3 id="Doctype">Doctype</h3> + +<p>Vous devez utiliser le doctype HTML5. Il est court, facile à retenir et rétrocompatible :</p> + +<pre class="brush: html example-good"><!DOCTYPE html></pre> + +<h3 id="Document_language">Langue du document</h3> + +<p>Définissez la langue du document à l'aide de l'attribut <a href="/fr/docs/Web/HTML/Global_attributes#lang"><code>lang</code></a> de votre élément <a href="/fr/docs/Web/HTML/Element/html"><code><html></code></a> :</p> + +<pre class="brush: html example-good"><html lang="fr"></pre> + +<p>C'est bon pour l'accessibilité et les moteurs de recherche, cela aide à localiser le contenu et cela rappelle aux gens d'utiliser les meilleures pratiques.</p> + +<h3 id="Document_characterset">Jeu de caractères du document</h3> + +<p>Vous devez également définir le jeu de caractères de votre document comme suit :</p> + +<pre class="brush: html example-good"><meta charset="utf-8"></pre> + +<p>Utilisez UTF-8 à moins que vous n'ayez une très bonne raison de ne pas le faire ; il couvrira vos besoins en caractères à peu près indépendamment de la langue que vous utilisez dans votre document. En outre, vous devriez toujours spécifier le jeu de caractères le plus tôt possible dans le bloc <a href="/fr/docs/Web/HTML/Element/head"><code><head></code></a> de votre HTML (dans le premier kilooctet), car cela vous protège contre une <a href="http://support.microsoft.com/kb/928847">vulnérabilité de sécurité d'Internet Explorer</a>.</p> + +<h3 id="Viewport_meta_tag">Méta-balise Viewport</h3> + +<p>Enfin, vous devez toujours ajouter la métabalise viewport dans votre HTML <a href="/fr/docs/Web/HTML/Element/head"><code><head></code></a>, pour donner à l'exemple une meilleure chance de fonctionner sur les appareils mobiles. Vous devez inclure au moins les éléments suivants dans votre document, que vous pourrez modifier ultérieurement en fonction des besoins :</p> + +<pre class="brush: html example-good"><meta name="viewport" content="width=device-width"></pre> + +<p>Voir <a href="/fr/docs/Web/CSS/Viewport_concepts#mobile_viewports">Zones d'affichage sur mobiles</a> pour plus de détails.</p> + +<h2 id="General_markup_coding_style">Style général de codage des balises</h2> + +<h3 id="Use_lowercase">Utiliser les minuscules</h3> + +<p>Utilisez les minuscules pour tous les noms d'éléments et les noms/valeurs d'attributs, car elles sont plus nettes et vous permettent d'écrire plus rapidement les balises :</p> + +<p>C'est bien :</p> + +<pre class="brush: html example-good"><p class="nice">Ça a l'air sympa et soigné</p></pre> + +<p>Ce n'est pas très bon :</p> + +<pre class="brush: html example-bad"><P CLASS="WHOA-THERE">Pourquoi mon balisage crie-t-il ?</P></pre> + +<h3 id="Trailing_slashes">Barre oblique de fermeture (slash)</h3> + +<p>N'incluez pas les barres obliques de fin de style XHTML pour les éléments vides, car elles sont inutiles et ralentissent le processus. Elles peuvent également casser les anciens navigateurs si vous ne faites pas attention (bien que, d'après ce dont nous nous souvenons, cela n'a pas été un problème depuis Netscape 4).</p> + +<p>C'est bon :</p> + +<pre class="brush: html example-good"><input type="text"> +<hr></pre> + +<p>Les barres obliques ne sont pas nécessaires :</p> + +<pre class="brush: html example-bad"><input type="text" /> +<hr /></pre> + +<h3 id="Quoting_attributes">Guillemets des attributs</h3> + +<p>Vous devez mettre toutes les valeurs d'attribut entre guillemets. Il est tentant d'omettre les guillemets puisque HTML5 le permet, mais le balisage est plus net et plus facile à lire si vous les incluez. Par exemple, ceci est mieux :</p> + +<pre class="brush: html example-good"><img src="images/logo.jpg" alt="Une icône de globe circulaire" class="no-border"></pre> + +<p>que ça :</p> + +<pre class="brush: html example-bad"><img src=images/logo.jpg alt=Une icône de globe circulaire class=no-border></pre> + +<p>Cela peut également causer des problèmes - dans l'exemple ci-dessus, l'attribut <code>alt</code> sera interprété comme plusieurs attributs, car il n'y a pas de guillemets pour spécifier que "Une icône de globe circulaire" est une valeur d'attribut unique.</p> + +<h3 id="Use_double_quotes">Utiliser les guillemets doubles</h3> + +<p>Utilisez des guillemets doubles pour le HTML, et non des guillemets simples :</p> + +<pre class="brush: html example-good"><p class="important">Yes</p></pre> + +<pre class="brush: html example-bad"><p class='important'>Nope</p></pre> + +<h3 id="Boolean_attributes">Attributs booléens</h3> + +<p>N'écrivez pas les attributs booléens en entier ; vous pouvez simplement écrire le nom de l'attribut pour le définir. Par exemple, vous pouvez écrire :</p> + +<pre class="brush: html example-good">required</pre> + +<p>Ceci est parfaitement compréhensible et fonctionne bien ; la version plus longue avec la valeur est acceptée mais n'est pas nécessaire :</p> + +<pre class="brush: html example-bad">required="required"</pre> + +<h3 id="Class_and_ID_names">Noms de classes et d'ID</h3> + +<p>Utilisez des noms de classe/ID sémantiques et séparez les mots multiples par des traits d'union. N'utilisez pas de camelCase.</p> + +<p>Bon :</p> + +<pre class="brush: html example-good"><p class="editorial-summary">Blah blah blah</p></pre> + +<p>Mauvais :</p> + +<pre class="brush: html example-bad"><p class="bigRedBox">Blah blah blah</p></pre> + +<h3 id="Entity_references">Références des entités</h3> + +<p>N'utilisez pas inutilement les références d'entités - utilisez le caractère littéral chaque fois que cela est possible (vous devrez toujours échapper les caractères comme les crochets et les guillemets).</p> + +<p>Par exemple, vous pourriez simplement écrire</p> + +<pre class="brush: html example-good"><p>© 2018 Me</p></pre> + +<p>Au lieu de</p> + +<pre class="brush: html example-bad"><p>&copy; 2018 Me</p></pre> + +<p>Cela ne pose aucun problème tant que vous déclarez un jeu de caractères UTF-8.</p> + +<h2 id="Good_HTML_examples_on_MDN">De bons exemples HTML sur MDN</h2> + +<p>Vous pouvez trouver de bons extraits HTML, concis et significatifs, en haut des <a href="/fr/docs/Web/HTML/Reference">pages de référence HTML</a> - nos exemples interactifs sont généralement rédigés de manière à suivre ces directives, mais sachez qu'ils peuvent différer à certains endroits car ils ont pour la plupart été rédigés avant la nouvelle rédaction des directives.</p> diff --git a/files/fr/mdn/guidelines/code_guidelines/index.html b/files/fr/mdn/guidelines/code_guidelines/index.html index d912615e54..58ab589009 100644 --- a/files/fr/mdn/guidelines/code_guidelines/index.html +++ b/files/fr/mdn/guidelines/code_guidelines/index.html @@ -1,5 +1,5 @@ --- -title: Guide des lignes directrices +title: Lignes directrices pour les fragments de code slug: MDN/Guidelines/Code_guidelines tags: - CSS @@ -14,39 +14,35 @@ original_slug: MDN/Guidelines/Code_lignesdirectrices --- <div>{{MDNSidebar}}</div> -<div>{{IncludeSubnav("/fr/docs/MDN")}}</div> - -<div> -<p class="summary"><span class="seoSummary">Cette série de documents décrit les directives de codage et les meilleures pratiques que nous utilisons pour écrire des démonstrations, des extraits de code, des exemples interactifs, etc. à utiliser sur MDN.</span></p> +<p class="summary">Cette série de documents décrit les directives de codage et les meilleures pratiques que nous utilisons pour écrire des démonstrations, des extraits de code, des exemples interactifs, etc. à utiliser sur MDN.</p> <p>Si vous cherchez des lignes directrices à suivre pour rédiger vos exemples de codes, vous êtes au bon endroit. Le plus grand avantage de respecter ces directives est qu'elles favoriseront la cohérence entre nos échantillons et nos démos sur MDN, ce qui augmente la lisibilité et la compréhension en général.</p> -</div> -<div class="note"> -<p><strong>Note</strong>: Si vous souhaitez obtenir des conseils sur le style du code tel qu'il apparaît sur un article de MDN, plutôt que sur le contenu du code, consultez notre <a href="/fr-FR/docs/MDN/Contribute/Guidelines/Writing_style_guide#Code_sample_style_and_formatting">Guide de formatage</a>.</p> +<div class="notecard note"> + <p><strong>Note</strong>: Si vous souhaitez obtenir des conseils sur le style du code tel qu'il apparaît sur un article de MDN, plutôt que sur le contenu du code, consultez notre <a href="/fr/docs/MDN/Guidelines/Writing_style_guide#code_sample_style_and_formatting">Guide stylistique</a>.</p> </div> -<h2 id="Structure_de_larticle">Structure de l'article</h2> +<h2 id="Article_structure">Structure d'article</h2> <p>Cet article contient les meilleures pratiques générales de haut niveau pour la rédaction d'exemples de codes MDN. Ses sous-articles sont les suivants :</p> <ul> - <li><a href="/en-US/docs/MDN/Contribute/Guidelines/Code_guidelines/General">Lignes directrices générales pour tous les codes</a> — à la fois syntaxique et pour des exemples de stylisme/affichage</li> - <li><a href="/en-US/docs/MDN/Contribute/Guidelines/Code_guidelines/HTML">Lignes directrices du HTML</a></li> - <li><a href="/en-US/docs/MDN/Contribute/Guidelines/Code_guidelines/CSS">Lignes directrices du CSS</a></li> - <li><a href="/en-US/docs/MDN/Contribute/Guidelines/Code_guidelines/JavaScript">Lignes directrices du JavaScript</a></li> - <li><a href="/en-US/docs/MDN/Contribute/Guidelines/Code_guidelines/Shell">Lignes directrices des commandes Shell</a></li> + <li><a href="/fr/docs/MDN/Guidelines/Code_guidelines/General">Lignes directrices générales pour tous les codes</a> — à la fois syntaxique et pour des exemples de stylisme/affichage</li> + <li><a href="/fr/docs/MDN/Guidelines/Code_guidelines/HTML">Lignes directrices du HTML</a></li> + <li><a href="/fr/docs/MDN/Guidelines/Code_guidelines/CSS">Lignes directrices du CSS</a></li> + <li><a href="/fr/docs/MDN/Guidelines/Code_guidelines/JavaScript">Lignes directrices du JavaScript</a></li> + <li><a href="/fr/docs/MDN/Guidelines/Code_guidelines/Shell">Lignes directrices des commandes Shell</a></li> </ul> -<h2 id="Meilleures_pratiques_générales">Meilleures pratiques générales</h2> +<h2 id="General_best_practices">Bonnes pratiques générales</h2> <p>Cette section fournit rapidement les meilleures pratiques générales pour créer un échantillon de code minimal compréhensible afin de démontrer l'utilisation d'une caractéristique ou d'une fonction spécifique.</p> <p>Les échantillons de code doivent l'être :</p> <ul> - <li>assez simple pour être compréhensible, mais</li> - <li>suffisamment complexe pour faire quelque chose d'intéressant, et de préférence utile.</li> + <li>assez simple pour être compréhensible, mais</li> + <li>suffisamment complexe pour faire quelque chose d'intéressant, et de préférence utile.</li> </ul> <p>Il y a une considération primordiale que vous devez garder à l'esprit : <strong>Les lecteurs copieront et colleront l'échantillon de code dans leur propre code, et pourront le mettre en production.</strong></p> @@ -55,24 +51,14 @@ original_slug: MDN/Guidelines/Code_lignesdirectrices <p>Les échantillons de code doivent être aussi autonomes et faciles à comprendre que possible. L'objectif n'est pas nécessairement de produire un code efficace et intelligent qui impressionne les experts et possède une grande fonctionnalité, mais plutôt de produire des exemples de travail réduits qui peuvent être compris le plus rapidement possible.</p> -<ul> -</ul> - -<div id="magicdomid13"><span class="author-g-frc9o9ihh5c9qyd0">Lignes directrices :</span></div> - -<div id="magicdomid14"></div> - -<div id="magicdomid15"> -<ul> - <li>L'échantillon doit être court et, dans l'idéal, ne montrer que l'élément qui vous intéresse immédiatement.</li> - <li><strong>N'incluez</strong> que le code qui est essentiel pour l'exemple. Une grande quantité de code non pertinent peut facilement distraire ou embrouiller le public. Si vous souhaitez fournir un exemple complet et plus long, placez-le dans l'un de nos <span class="author-g-frc9o9ihh5c9qyd0"><a href="https://github.com/mdn/">dépôts Github</a></span> (ou un JSBin, Codepen ou similaire) et fournissez ensuite le lien vers la version complète au-dessus ou au-dessous de l'exemple.</li> - <li>N'incluez pas de code inutile côté serveur, de bibliothèques, de cadres, de préprocesseurs et d'autres dépendances de ce type <span class="author-g-frc9o9ihh5c9qyd0">—</span> ils rendent le code moins portable et plus difficile à exécuter et à comprendre. Utilisez du code "vanilla" lorsque c'est possible.</li> - <li>Ne supposez pas que vous connaissez des bibliothèques, des cadres, des préprocesseurs ou d'autres caractéristiques non natives. Par exemple, utilisez des noms de classe qui ont un sens dans l'exemple plutôt que des noms de classe qui ont un sens pour les utilisateurs de BEM ou de Bootstrap.</li> - <li>Écrivez votre code de la façon la plus propre et la plus compréhensible possible, même si ce n'est pas la façon la plus efficace de le faire.</li> - <li>N'utilisez pas de mauvaises pratiques par souci de brièveté (comme les éléments de présentation tels que<span class="author-g-frc9o9ihh5c9qyd0"> {{HTMLElement("big")}} ou {{domxref("Document.write", "document.write()")}}); </span>faites-le correctement.</li> - <li>Dans le cas de démonstrations d'API, si vous utilisez plusieurs API ensemble, indiquez quelles API sont incluses et quelles fonctionnalités proviennent d'où.</li> -</ul> -</div> +<p>Les autres meilleures pratiques générales sont les suivantes :</p> <ul> + <li>L'échantillon doit être court et, idéalement, ne montrer que la caractéristique qui vous intéresse immédiatement.</li> + <li><strong>Seulement</strong> inclure le code qui est essentiel pour l'exemple. Une grande quantité de code non pertinent peut facilement distraire ou embrouiller le public. Si vous souhaitez fournir un exemple complet, plus long, mettez-le dans l'un de nos <a href="https://github.com/mdn/">Dépôts GitHub</a> (ou un JSBin, CodePen, ou similaire) et fournissez ensuite le lien vers la version complète au-dessus ou au-dessous de l'échantillon.</li> + <li>N'incluez pas de code côté serveur, de bibliothèques, de frameworks, de préprocesseurs et autres dépendances inutiles - ils rendent le code moins portable et plus difficile à exécuter et à comprendre. Utilisez du code "vanilla" lorsque cela est possible.</li> + <li>Ne présumez pas de la connaissance des bibliothèques, des frameworks, des préprocesseurs ou d'autres fonctionnalités non natives. Par exemple, utilisez des noms de classe qui ont un sens dans l'exemple plutôt que des noms de classe qui ont un sens pour les utilisateurs de BEM ou Bootstrap.</li> + <li>Écrivez votre code de manière aussi propre et compréhensible que possible, même si ce n'est pas la manière la plus efficace de le faire.</li> + <li>N'utilisez pas de mauvaises pratiques pour faire court (comme des éléments de présentation tels que <a href="/fr/docs/Web/HTML/Element/big"><code><big></code></a> ou <a href="/fr/docs/Web/API/Document/write"><code>document.write()</code></a>) ; faites-le correctement.</li> + <li>Dans le cas des démonstrations d'API, si vous utilisez plusieurs API ensemble, indiquez quelles API sont incluses ainsi que l'origine des fonctionnalités.</li> </ul> diff --git a/files/fr/mdn/guidelines/code_guidelines/javascript/index.html b/files/fr/mdn/guidelines/code_guidelines/javascript/index.html new file mode 100644 index 0000000000..9d390983eb --- /dev/null +++ b/files/fr/mdn/guidelines/code_guidelines/javascript/index.html @@ -0,0 +1,504 @@ +--- +title: Lignes directrices pour JavaScript +slug: MDN/Guidelines/Code_guidelines/JavaScript +tags: + - Code + - Guide + - Directives + - JavaScript + - MDN Meta +translation_of: MDN/Guidelines/Code_guidelines/JavaScript +--- +<div>{{MDNSidebar}}</div> + +<p class="summary">Les directives suivantes couvrent la manière d'écrire le JavaScript pour les exemples de code MDN.</p> + +<p>Ce qui suit est un ensemble assez simple de directives JavaScript. Nous pourrions aller beaucoup plus en profondeur sur ce sujet, mais nous voulons essentiellement fournir des directives simples pour écrire des exemples concis qui seront compréhensibles par le plus grand nombre de personnes possible, plutôt que des directives détaillées pour écrire des applications web complexes. Si vous voulez quelque chose qui entre dans plus de détails, nous vous recommandons le <a href="https://github.com/airbnb/javascript">guide stylistique JavaScript d'AirBnB</a>, qui est généralement compatible avec nos directives.</p> + +<h2 id="In_this_article">Dans cet article</h2> + +<ul> + <li><a href="#general_javascript_guidelines">Directives générales sur le JavaScript</a> + <ul> + <li><a href="#use_expanded_syntax">Utiliser une syntaxe étendue</a></li> + <li><a href="#javascript_comments">Commentaires JavaScript</a></li> + <li><a href="#use_es6_features">Utiliser les fonctions ES6</a></li> + </ul> + </li> + <li><a href="#variables">Variables</a> + <ul> + <li><a href="#variable_naming">Nommage des variables</a></li> + <li><a href="#declaring_variables">Déclaration des variables</a></li> + </ul> + </li> + <li><a href="#operators_and_comparison">Opérateurs et comparaison</a> + <ul> + <li><a href="#ternary_operators">Opérateurs ternaires</a></li> + <li><a href="#use_strict_equality">Utiliser l'égalité stricte</a></li> + <li><a href="#use_shortcuts_for_boolean_tests">Utiliser des raccourcis pour les tests booléens</a></li> + </ul> + </li> + <li><a href="#control_statements">Instructions de contrôle</a></li> + <li><a href="#strings">Chaînes de caractères</a> + <ul> + <li><a href="#use_template_literals">Utiliser des modèles littéraux</a></li> + <li><a href="#use_textcontent_not_innerhtml">Utiliser textContent, et non innerHTML</a></li> + </ul> + </li> + <li><a href="#conditionals">Conditions</a> + <ul> + <li><a href="#general_purpose_looping">Usage général des boucles</a></li> + <li><a href="#switch_statements">Les instructions switch</a></li> + </ul> + </li> + <li><a href="#functions_and_objects">Fonctions et objets</a> + <ul> + <li><a href="#function_naming">Nommage des fonctions</a></li> + <li><a href="#defining_functions">Définition des fonctions</a></li> + <li><a href="#creating_objects">Création d'objets</a></li> + <li><a href="#object_classes">Classes d'objets</a></li> + <li><a href="#object_naming">Nommage des objets</a></li> + </ul> + </li> + <li><a href="#arrays">Tableaux</a> + <ul> + <li><a href="#creating_arrays">Création de tableaux</a></li> + <li><a href="#adding_to_an_array">Ajout à un tableau</a></li> + </ul> + </li> + <li><a href="#error_handling">Traitement des erreurs</a></li> +</ul> + +<h2 id="General_JavaScript_guidelines">Directives générales sur le JavaScript</h2> + +<h3 id="Use_expanded_syntax">Utiliser une syntaxe étendue</h3> + +<p>Pour JavaScript, nous utilisons une syntaxe étendue, chaque ligne de JS étant placée sur une nouvelle ligne, l'accolade d'ouverture d'un bloc sur la même ligne que l'instruction associée et l'accolade de fermeture sur une nouvelle ligne. Cela permet d'optimiser la lisibilité et de favoriser la cohérence sur le MDN.</p> + +<p>Faites ceci</p> + +<pre class="brush: js example-good">function myFunc() { + console.log('Hello!'); +};</pre> + +<p>Évitez cela</p> + +<pre class="brush: js example-bad">function myFunc() { console.log('Hello!'); };</pre> + +<p>Nous avons également quelques règles spécifiques concernant l'espacement à l'intérieur des caractéristiques du langage. Vous devez inclure des espaces entre les opérateurs et les opérandes, les paramètres, etc.</p> + +<p>C'est plus lisible</p> + +<pre class="brush: js example-good">if(dayOfWeek === 7 && weather === 'soleil') { + goOnTrip('plage', 'voiture', ['crême glacée', 'pelle et sceau', 'serviette de plage']); +}</pre> + +<p>que ceci</p> + +<pre class="brush: js example-bad">if(dayOfWeek===7&&weather==='soleil'){ + goOnTrip('plage','voiture',['crême glacée','pelle et sceau','serviette de plage']); +}</pre> + +<p>En outre, gardez ces spécificités à l'esprit :</p> + +<ul> + <li>N'incluez pas d'espaces de remplissage après les parenthèses ouvrantes ou avant les parenthèses fermantes - <code>(myVar)</code>, et non <code>( myVar )</code>.</li> + <li>Toutes les instructions doivent se terminer par un point-virgule (";"). Nous les exigeons dans tous nos exemples de code, même s'ils sont techniquement facultatifs en JavaScript, car nous pensons que cela permet d'obtenir un code plus clair et plus précis quant à la fin de chaque instruction.</li> + <li>Utilisez des guillemets simples en JavaScript, chaque fois que des guillemets simples sont nécessaires dans la syntaxe.</li> + <li>Il ne doit pas y avoir d'espace entre un mot-clé d'instruction, une fonction ou une boucle et sa parenthèse ouvrante (par exemple, <code>if() { .... }</code>, <code>fonction myFunc() { ... }, for(...) { ... }</code>).</li> + <li>Il doit y avoir un espace entre les parenthèses et l'accolade ouvrante dans les cas décrits au point précédent.</li> +</ul> + +<h3 id="JavaScript_comments">Commentaires JavaScript</h3> + +<p>Utilisez des commentaires de style JS pour commenter le code qui n'est pas auto-documenté :</p> + +<pre class="brush: js example-good">// This is a JavaScript-style comment</pre> + +<p>Mettez vos commentaires sur des lignes séparées précédant le code auquel ils se réfèrent :</p> + +<pre class="brush: js example-good">function myFunc() { + // Affiche la chaîne de caractères "Bonjour" dans la console JS du navigateur. + console.log('Bonjour'); + // Crée un nouveau paragraphe, le remplit de contenu et l'ajoute au <body> + let para = document.createElement('p'); + para.textContent = 'Mon nouveau paragraphe'; + document.body.appendChild(para); +}</pre> + +<p>Notez également que vous devez laisser un espace entre les barres obliques et le commentaire, dans chaque cas.</p> + +<h3 id="Use_ES6_features">Utiliser les fonctions ES6</h3> + +<p>Pour un usage général*, vous pouvez utiliser les fonctionnalités ES6 courantes (telles que les <a href="/fr/docs/Web/JavaScript/Reference/Functions/Arrow_functions">fonctions fléchées</a>, <a href="/fr/docs/Web/JavaScript/Reference/Global_Objects/Promise">promesses</a>, <code><a href="/fr/docs/Web/JavaScript/Reference/Statements/let">let</a></code>/<code><a href="/fr/docs/Web/JavaScript/Reference/Statements/const">const</a></code>, <a href="/fr/docs/Web/JavaScript/Reference/Template_literals">littéraux de gabarits</a>, et le <a href="/fr/docs/Web/JavaScript/Reference/Operators/Spread_syntax">syntaxe de décomposition</a>) dans les exemples MDN. Nous les incluons à de nombreux endroits dans ces directives, car nous pensons que l'industrie du Web a généralement atteint un point où ces fonctionnalités sont suffisamment familières pour être compréhensibles. Et pour ceux qui ne les utilisent pas encore, nous aimerions jouer notre rôle en aidant les gens à développer leurs compétences.</p> + +<p>Cependant, nous ne recommandons pas encore l'utilisation générale des nouvelles fonctionnalités ES telles que <a href="/fr/docs/Web/JavaScript/Reference/Statements/async_function">async</a>/<a href="/fr/docs/Web/JavaScript/Reference/Operators/await">await</a>, les virgules de fin sur les listes d'arguments, etc. Nous préférerions que vous ne les utilisiez pas, sauf si cela est strictement nécessaire, et si vous les utilisez, incluez une explication dans votre exemple pour dire ce qu'ils font, avec un lien vers le matériel de référence approprié.</p> + +<div class="notecard note"> + <p><b>Note :</b></p> + <p>* Par "usage général", nous entendons la rédaction d'exemples généraux. Les pages de référence couvrant des fonctionnalités spécifiques de l'ES moderne doivent évidemment utiliser les fonctionnalités qu'elles documentent !</p> +</div> + +<h2 id="Variables">Variables</h2> + +<h3 id="Variable_naming">Nommage des variables</h3> + +<p>Pour les noms de variables, utilisez la casse minuscule au format chameau « lowerCamelCase » et, le cas échéant, des noms concis, lisibles par l'homme et sémantiques.</p> + +<p>Écrivez comme suit :</p> + +<pre class="brush: js example-good">let playerScore = 0; + +let speed = distance / time;</pre> + +<p>Éviter ce genre de chose :</p> + +<pre class="brush: js example-bad">let thisIsaveryLONGVariableThatRecordsPlayerscore345654 = 0; + +let s = d/t; +</pre> + +<div class="notecard note"> + <p><b>Note :</b></p> + <p>The only place where it is OK to not use human-readable semantic names is where a very common recognized convention exists, such as using <code>i</code>, <code>j</code>, etc. for loop iterators.</p> +</div> + +<h3 id="Declaring_variables">Déclaration des variables</h3> + +<p>Lorsque vous déclarez des variables et des constantes, utilisez les mots-clés <code><a href="/fr/docs/Web/JavaScript/Reference/Statements/let">let</a></code> et <code><a href="/fr/docs/Web/JavaScript/Reference/Statements/const">const</a></code>, pas <code><a href="/fr/docs/Web/JavaScript/Reference/Statements/var">var</a></code>.</p> + +<p>Si une variable ne sera pas réaffectée, préférez <code>const</code> :</p> + +<pre class="brush: js example-good">const myName = 'Chris'; +console.log(myName); +</pre> + +<p>Sinon, utilisez <code>let</code> :</p> + +<pre class="brush: js example-good">let myAge = '40'; +myAge++; +console.log('Happy birthday!'); +</pre> + +<p>Cet exemple utilise <code>let</code> là où il devrait préférer <code>const</code>. Il fonctionnera mais devrait être évité dans les exemples de code MDN :</p> + +<pre class="brush: js example-bad">let myName = 'Chris'; +console.log(myName); +</pre> + +<p>Cet exemple utilise <code>const</code> pour une variable qui est réaffectée. La réaffectation entraînera une erreur :</p> + +<pre class="brush: js example-bad">const myAge = '40'; +myAge++; +console.log('Happy birthday!'); +</pre> + +<p>Cet exemple utilise <code>var</code>, ce qui doit être évité dans les exemples de code MDN, sauf si cela est vraiment nécessaire :</p> + +<pre class="brush: js example-bad">var myAge = '40'; +var myName = 'Chris';</pre> + +<h2 id="Operators_and_comparison">Opérateurs et comparaison</h2> + +<h3 id="Ternary_operators">Opérateurs ternaires</h3> + +<p>Les opérateurs ternaires doivent être placés sur une seule ligne :</p> + +<pre class="brush: js example-good">let status = (age >= 18) ? 'adult' : 'minor';</pre> + +<p>Pas emboîtés :</p> + +<pre class="brush: js example-bad">let status = (age >= 18) + ? 'adult' + : 'minor';</pre> + +<p>C'est beaucoup plus difficile à lire.</p> + +<h3 id="Use_strict_equality">Utiliser l'égalité stricte</h3> + +<p>Utilisez toujours une égalité et une inégalité strictes.</p> + +<p>Comme ceci :</p> + +<pre class="brush: js example-good">name === 'Chris'; +age !== 25;</pre> + +<p>N'écrivez pas comme ça :</p> + +<pre class="brush: js example-bad">name == 'Chris'; +age != 25;</pre> + +<h3 id="Use_shortcuts_for_boolean_tests">Utiliser des raccourcis pour les tests booléens</h3> + +<p>Utilisez des raccourcis pour les tests booléens - utilisez <code>x</code> et <code>!x</code>, et non <code>x === true</code> et <code>x === false</code>.</p> + +<h2 id="Control_statements">Instructions de contrôle</h2> + +<p>Écrivez des instructions de contrôle comme ceci :</p> + +<pre class="brush: js example-good">if(iceCream) { + alert('Woo hoo!'); +}</pre> + +<p>Pas comme cela :</p> + +<pre class="brush: js example-bad">if (iceCream){ + alert('Woo hoo!'); +}</pre> + +<p>N'oubliez pas non plus :</p> + +<ul> + <li>Il ne doit y avoir <em>aucun espace</em> entre un mot-clé de déclaration de contrôle et sa parenthèse ouvrante.</li> + <li>Il doit y avoir <em>un espace</em> entre les parenthèses et l'accolade ouvrante.</li> +</ul> + +<h2 id="Strings">Chaînes de caractères</h2> + +<h3 id="Use_template_literals">Utiliser des modèles littéraux</h3> + +<p>Pour insérer des valeurs dans des chaînes de caractères, utilisez des chaînes de caractères littérales.</p> + +<p>Comme suit :</p> + +<pre class="brush: js example-good">let myName = 'Chris'; +console.log(`Hi! I'm ${myName}!`);</pre> + +<p>En évitant d'écrire :</p> + +<pre class="brush: js example-bad">let myName = 'Chris'; +console.log('Hi! I\'m' + myName + '!');</pre> + +<h3 id="Use_textContent_not_innerHTML">Utiliser textContent, et non innerHTML</h3> + +<p>Lorsque vous insérez des chaînes de caractères dans les nœuds du DOM, utilisez la fonction <a href="/fr/docs/Web/API/Node/textContent"><code>Node.textContent</code></a>:</p> + +<pre class="brush: js example-good">let text = 'Bonjour à vous tous, braves gens'; +const para = document.createElement('p'); +para.textContent = text;</pre> + +<p>Et pas <a href="/fr/docs/Web/API/Element/innerHTML"><code>Element.innerHTML</code></a>:</p> + +<pre class="brush: js example-bad">let text = 'Bonjour à vous tous, braves gens'; +const para = document.createElement('p'); +para.innerHTML = text;</pre> + +<p>Le <code>textContent</code> est beaucoup plus efficace, et moins sujet aux erreurs que le <code>innerHTML</code>.</p> + +<h2 id="Conditionals">Conditions</h2> + +<h3 id="General_purpose_looping">Usage général des boucles</h3> + +<p>When <a href="/fr/docs/Learn/JavaScript/Building_blocks/Looping_code">loops</a> are required, feel free to choose an appropriate loop out of the available ones (<code><a href="/fr/docs/Web/JavaScript/Reference/Statements/for">for</a></code>, <code><a href="/fr/docs/Web/JavaScript/Reference/Statements/for...of">for...of</a></code>, <code><a href="/fr/docs/Web/JavaScript/Reference/Statements/while">while</a></code>, etc.) Just make sure to keep the code as understandable as possible.</p> + +<p>Lorsque vous utilisez des boucles <code>for</code>/<code>for...of</code>, veillez à définir correctement l'initialisateur, avec un mot clé <code>let</code> :</p> + +<pre class="brush: js example-good">let cats = ['Athena', 'Luna']; +for(let i of cats) { + console.log(i); +} +</pre> + +<p>Pas</p> + +<pre class="brush: js example-bad">let cats = ['Athena', 'Luna']; +for(i of cats) { + console.log(i); +} +</pre> + +<p>Gardez également à l'esprit :</p> + +<ul> + <li>Il ne doit y avoir <em>aucun espace</em> entre un mot-clé de boucle et sa parenthèse ouvrante.</li> + <li>Il doit y avoir <em>un espace</em> entre les parenthèses et l'accolade ouvrante.</li> +</ul> + +<h3 id="Switch_statements">Les instructions switch</h3> + +<p>Formatez les instructions <code>switch</code> comme suit :</p> + +<pre class="brush: js example-good">let expr = 'Papayes'; +switch(expr) { + case 'Oranges': + console.log('Les oranges sont à 1,10 € le kilo.'); + break; + case 'Papayes': + console.log('Les mangues et les papayes sont à 5,24 € le kilo.'); + // résultat attendu : "Les mangues et les papayes sont à 5,24 € le kilo." + break; + default: + console.log('Désolé, nous n'avons plus de ' + expr + '.'); +}</pre> + +<h2 id="Functions_and_objects">Fonctions et objets</h2> + +<h3 id="Function_naming">Nommage des fonctions</h3> + +<p>Pour les noms de fonctions, utilisez la casse minuscule au format chameau « lowevCamelCase » et, le cas échéant, des noms concis, lisibles par l'homme et sémantiques.</p> + +<p>Par exemple :</p> + +<pre class="brush: js example-good">function sayHello() { + alert('Bonjour !'); +};</pre> + +<p>En évitant de faire :</p> + +<pre class="brush: js example-bad">function SayHello() { + alert('Bonjour !'); +}; + +function notVeryObviousName() { + alert('Bonjour !'); +}; +</pre> + +<div class="notecard note"> + <p><b>Note :</b></p> + <p>Le seul endroit où il est acceptable de ne pas utiliser des noms sémantiques lisibles par l'homme est lorsqu'une convention reconnue très courante existe, comme l'utilisation de <code>i</code>, <code>j</code>, etc. pour les itérateurs de boucle.</p> +</div> + +<h3 id="Defining_functions">Définition des fonctions</h3> + +<p>Dans la mesure du possible, utilisez la déclaration <code>fonction</code> pour définir des fonctions sur des expressions de fonction :</p> + +<p>Faites comme ça :</p> + +<pre class="brush: js example-good">function sum(a, b) { + return a + b; +}</pre> + +<p>Pas comme ça :</p> + +<pre class="brush: js example-bad">let sum = function(a, b) { + return a + b; +}</pre> + +<p>Lorsque vous utilisez des fonctions anonymes à l'intérieur d'une méthode qui requiert une fonction comme paramètre, il est acceptable (mais pas obligatoire) d'utiliser une fonction flèche pour rendre le code plus court et plus propre.</p> + +<p>Donc, au lieu de ça :</p> + +<pre class="brush: js example-good">const array1 = [1, 2, 3, 4]; +let sum = array.reduce(function(a, b) { + return a + b; +});</pre> + +<p>vous pourriez écrire ceci :</p> + +<pre class="brush: js example-good">const array = [1, 2, 3, 4]; +let sum = array.reduce((a, b) => + a + b +);</pre> + +<p>N'oubliez pas non plus :</p> + +<ul> + <li>Il ne doit y avoir <em>aucun espace</em> entre un nom de fonction et sa parenthèse ouvrante.</li> + <li>Il doit y avoir <em>un espace</em> entre les parenthèses et l'accolade ouvrante.</li> +</ul> + +<h3 id="Creating_objects">Création d'objets</h3> + +<p>Utilisez des littéraux - et non des constructeurs - pour créer des objets généraux (c'est-à-dire lorsque les classes ne sont pas concernées) :</p> + +<p>Par exemple :</p> + +<pre class="brush: js example-good">let myObject = { };</pre> + +<p>Et pas :</p> + +<pre class="brush: js example-bad">let myObject = new Object();</pre> + +<h3 id="Object_classes">Classes d'objets</h3> + +<p>Utilisez la syntaxe de classe ES pour les objets, et non les constructeurs à l'ancienne.</p> + +<p>À titre d'exemples :</p> + +<pre class="brush: js example-good">class Person { + constructor(name, age, gender) { + this.name = name; + this.age = age; + this.gender = gender; + } + + greeting() { + console.log(`Salut ! Je m'appelle ${this.name}`); + }; +}</pre> + +<p>Utilisez <code>extends</code> pour l'héritage :</p> + +<pre class="brush: js example-good">class Teacher extends Person { + ... +}</pre> + +<h3 id="Object_naming">Nommage des objets</h3> + +<p>Lorsque vous définissez une classe d'objets (comme ci-dessus), utilisez l'écriture de casse au format chameau en majuscule « UpperCamelCase » (également connue sous le nom de « PascalCasing ») pour le nom de la classe, et la casse en minuscule « lowerCamelCase » pour les noms des propriétés et des méthodes de l'objet.</p> + +<p>Lors de la définition d'une instance d'objet, qu'il s'agisse d'un littéral ou d'un constructeur, utilisez le lowerCamelCase pour le nom de l'instance :</p> + +<pre class="brush: js example-good">let hanSolo = new Person('Han Solo', 25, 'male'); + +let hanSolo = { + name: 'Han Solo', + age: 25, + gender: 'male' +}</pre> + +<h2 id="Arrays">Tableaux</h2> + +<h3 id="Creating_arrays">Création de tableaux</h3> + +<p>Utilisez des littéraux - et non des constructeurs - pour créer des tableaux :</p> + +<p>Comme ceci :</p> + +<pre class="brush: js example-good">let myArray = [ ];</pre> + +<p>Pas comme ça :</p> + +<pre class="brush: js example-bad">let myArray = new Array(length);</pre> + +<h3 id="Adding_to_an_array">Ajout à un tableau</h3> + +<p>Pour ajouter des éléments à un tableau, utilisez <code><a href="/fr/docs/Web/JavaScript/Reference/Global_Objects/Array/push">push()</a></code>, et non l'affectation directe. Étant donné le tableau suivant :</p> + +<pre class="brush: js">const pets = [];</pre> + +<p>faites ça :</p> + +<pre class="brush: js example-good">pets.push('cat');</pre> + +<p>et pas ça :</p> + +<pre class="brush: js example-bad">pets[pets.length] = 'cat';</pre> + +<h2 id="Error_handling">Traitement des erreurs</h2> + +<p>Si certains états de votre programme lancent des erreurs non attrapées, ils interrompent l'exécution et réduisent potentiellement l'utilité de l'exemple. Vous devriez donc attraper les erreurs en utilisant un bloc <code><a href="/fr/docs/Web/JavaScript/Reference/Statements/try...catch">try...catch</a></code> :</p> + +<pre class="brush: js example-good">try { + console.log(results); +} +catch(e) { + console.error(e); +}</pre> + +<h2 id="Good_JavaScript_examples_on_MDN">De bons exemples de JavaScript sur MDN</h2> + +<p>Vous pouvez trouver de bons extraits de JavaScript, concis et significatifs, en haut de nos pages <a href="/fr/docs/Web/JavaScript/Reference">Référence du langage JavaScript</a> - parcourez-les pour en trouver.</p> + +<p>Nos exemples interactifs (et autres) sont généralement rédigés de manière à suivre les directives ci-dessus, mais sachez qu'ils peuvent différer à certains endroits, car ils ont été rédigés pour la plupart avant que les directives ne soient nouvellement rédigées.</p> + +<p>En ce qui concerne les exemples d'API, nous aimerions mettre en avant quelques exemples qui nous semblent bons :</p> + +<ul> + <li><a href="/fr/docs/Web/API/WindowOrWorkerGlobalScope/fetch#examples">Exemples de <code>fetch()</code></a></li> + <li><a href="/fr/docs/Web/API/CanvasRenderingContext2D/fillRect#examples">Exemples de <code>fillRect()</code></a> (les exemples de Canvas 2D sont généralement bons, bien qu'ils utilisent toujours l'ancienne déclaration <code>var</code>).</li> + <li><a href="/fr/docs/Web/API/PaymentRequest/show">Payment Request API <code>show()</code></a> (Les exemples de <a href="/fr/docs/Web/API/PaymentRequest"><code>PaymentRequest</code></a> sont généralement assez bons).</li> + <li><a href="/fr/docs/Web/API/Web_Audio_API/Using_Web_Audio_API">Utilisations de l'API Web Audio</a> (les bonnes pratiques générales en matière de HTML, CSS et JavaScript, ainsi qu'une bonne démonstration de l'utilisation des extraits et des liens vers des exemples complets ailleurs).</li> + <li><a href="/fr/docs/Web/API/Media_Capabilities_API/Using_the_Media_Capabilities_API">Utilisations de l'API Media Capabilities</a> (des bonnes pratiques plus générales pour l'utilisation des extraits de code dans un guide).</li> +</ul> diff --git a/files/fr/mdn/guidelines/code_guidelines/shell/index.html b/files/fr/mdn/guidelines/code_guidelines/shell/index.html new file mode 100644 index 0000000000..d00ea40c41 --- /dev/null +++ b/files/fr/mdn/guidelines/code_guidelines/shell/index.html @@ -0,0 +1,37 @@ +--- +title: Lignes directrices des exemples de lignes de commande +slug: MDN/Guidelines/Code_guidelines/Shell +tags: + - Code + - Guide + - Guidelines + - MDN Meta + - Shell +translation_of: MDN/Guidelines/Code_guidelines/Shell +--- +<div>{{MDNSidebar}}</div> + +<p class="summary">Les directives suivantes expliquent comment rédiger des exemples de lignes de commande sur MDN.</p> + +<h2 id="Shell_prompts_in_brief">Les commandes Shell en bref</h2> + +<p>Un <i>shell</i> est un programme qui attend que vous tapiez une commande et que vous appuyiez sur la touche retour. Pour indiquer les commandes que vous devez taper, la documentation MDN les répertorie dans un bloc de code, similaire aux exemples de code. Un tel bloc ressemble à ceci :</p> + +<pre class="brush: bash example-good"># Cela peut prendre un certain temps… +hg clone https://hg.mozilla.org/mozilla-central/ firefox +cd firefox</pre> + +<h2 id="Guidelines">Directives</h2> + +<p>Il existe quelques directives à suivre lors de l'écriture d'un bloc de code shell :</p> + +<ul> + <li>N'incluez pas de "$" ou de ">" au début d'une instruction shell. Cela perturbe plus qu'il n'aide et n'est pas utile pour copier les instructions.</li> + <li>Les commentaires commencent par "#".</li> + <li>Choisissez la coloration syntaxique "bash".</li> +</ul> + +<h2 id="Good_shell_prompt_examples_on_MDN">De bons exemples de commandes shell sur le MDN</h2> + +<p>Nos <a href="/fr/docs/Learn/Server-side/Django">Documents de développement côté serveur de Django</a> montrent une bonne pratique de présentation des commandes de l'invite shell, etc. sur le MDN. Regardez <a href="/fr/docs/Learn/Server-side/Django/development_environment">Configurer un environnement de développement Django</a> par exemple.</p> + |