From 33058f2b292b3a581333bdfb21b8f671898c5060 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 8 Dec 2020 14:40:17 -0500 Subject: initial commit --- .../guidelines/code_lignesdirectrices/index.html | 77 ++++++++++++++++++++++ files/fr/mdn/guidelines/index.html | 13 ++++ 2 files changed, 90 insertions(+) create mode 100644 files/fr/mdn/guidelines/code_lignesdirectrices/index.html create mode 100644 files/fr/mdn/guidelines/index.html (limited to 'files/fr/mdn/guidelines') diff --git a/files/fr/mdn/guidelines/code_lignesdirectrices/index.html b/files/fr/mdn/guidelines/code_lignesdirectrices/index.html new file mode 100644 index 0000000000..325b4fcb88 --- /dev/null +++ b/files/fr/mdn/guidelines/code_lignesdirectrices/index.html @@ -0,0 +1,77 @@ +--- +title: Guide des lignes directrices +slug: MDN/Guidelines/Code_lignesdirectrices +tags: + - CSS + - Code + - Guide + - HTML + - JavaScript + - MDN Meta + - Shell +translation_of: MDN/Guidelines/Code_guidelines +--- +
{{MDNSidebar}}
+ +
{{IncludeSubnav("/fr/docs/MDN")}}
+ +
+

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.

+ +

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.

+
+ +
+

Note: 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 Guide de formatage.

+
+ +

Structure de l'article

+ +

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 :

+ + + +

Meilleures pratiques générales

+ +

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.

+ +

Les échantillons de code doivent l'être :

+ + + +

Il y a une considération primordiale que vous devez garder à l'esprit : Les lecteurs copieront et colleront l'échantillon de code dans leur propre code, et pourront le mettre en production.

+ +

Par conséquent, vous devez vous assurer que l'exemple de code est utilisable et suit les meilleures pratiques généralement acceptées, et ne fait rien qui puisse rendre une application peu sûre, grossièrement inefficace, gonflée ou inaccessible. Si l'exemple de code n'est pas utilisable ou ne vaut pas la peine d'être produit, veillez à inclure un avertissement dans un commentaire de code et dans le texte explicatif — s'il s'agit d'un extrait et non d'un exemple complet, précisez-le clairement. Cela signifie également que vous devez fournir toutes les informations nécessaires à l'exécution de l'exemple, y compris les dépendances et la configuration.

+ +

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.

+ + + +
Lignes directrices :
+ +
+ +
+ +
+ + diff --git a/files/fr/mdn/guidelines/index.html b/files/fr/mdn/guidelines/index.html new file mode 100644 index 0000000000..613181debd --- /dev/null +++ b/files/fr/mdn/guidelines/index.html @@ -0,0 +1,13 @@ +--- +title: Guides du style et du contenu MDN +slug: MDN/Guidelines +tags: + - Documentation + - MDN +translation_of: MDN/Guidelines +--- +
{{MDNSidebar}}
{{IncludeSubnav("/fr/docs/MDN")}}
+ +

Ces guides fournissent des détails sur la manière de rédiger et de présenter la documentation MDN, mais également sur la façon dont les extraits de code et le contenu en général devraient être présentés. En respectant ces guides, vous êtes garantis que ce que vous produisez est propre et facile à utiliser.

+ +

{{LandingPageListSubpages}}

-- cgit v1.2.3-54-g00ecf