Les formats de code et les commentaires sont lrsquoune des choses que ne remarquerez qursquoune fois qursquoils auront disparu. Srsquoils sont utilisés pour visualiser et enregistrer correctement le Code, ne remarquerez leur présence que si rencontrez les blocs de code qui les manquent pour la première fois. Tôt ou tard, la plupart des personnes qui gèrent ou possèdent un site Web devront apporter des changements à la base de code. Cela peut se produire lorsque créez un nouvel élément HTML, insérez un CSS personnalisé, ou changez un modèle PHP WordPress. Pour srsquoassurer qursquoil nrsquoy a pas de confusion, dans nous examinons les meilleures pratiques de formatage du Code et des commentaires. Vous apprendrez pourquoi ils sont essentiels et comment les utiliser correctement.
Comme il existe de nombreux langages de programmation et de balisage avec des conventions différentes, nous nous limiterons aux langages les plus courants dans la conception web, à savoir HTML, css, PHP et JavaScript. Pourquoi formater et enregistrer le code? Avant drsquoentrer dans la procédure, parlons de pourquoi crsquoest important. Premièrement, le formatage et lrsquoannotation du Code ne sont pas réellement nécessaires au fonctionnement de la fonction. Une machine comme un navigateur est parfaitement capable de la lire et de lrsquoexécuter. C’est pourquoi pouvez utiliser des techniques telles que la minimisation pour accélérer votre site WordPress.
Tant que le Code est correct et qursquoil nrsquoy a pas drsquoerreur, lrsquoordinateur se fiche que le code soit beau ou pas. Cependant, il rend les étiquettes plus lisibles. Savez qui se soucie du formatage du Code et des commentaires? Humains. Des gens comme et moi qui ont besoin de lire, de comprendre et de modifier le Code de temps en temps. Dans ces cas, crsquoest plus facile si avez le bon format et ou commentaires pour rendre le code plus facile à comprendre. Ne pas utiliser de format dans le Code équivaut à ne pas utiliser de format
Écris. supprimez tous les paragraphes et titres, ne lirez même pas aussi bon soit il.
Pour cette raison, des conventions ont été proposées pour srsquoassurer que le Code est aussi facile à comprendre que possible. Cela permet drsquoéviter les erreurs, de résoudre les problèmes et de simplifier considérablement lrsquoentretien du travail des autres (et même de même). Cependant, il est important de noter qursquoil nrsquoexiste pas de méthode claire pour définir le style du Code. Par exemple, différents formats sont significatifs pour différentes étiquettes. Lrsquoapplication du format CSS au HTML ou du format CSS au HTML ne le rend pas nécessairement plus facile à comprendre.
Il existe donc des conventions différentes selon la langue utilisée. Cependant, ils tournent essentiellement autour des fonctions de Convention de nommage et de capitalisation des espaces indentés, du style et de lrsquoorthographe des variables, et drsquoautres styles drsquoutilisation et drsquoannotation dans ces conventions plus larges, les développeurs utilisent généralement leurs propres styles selon leurs préférences. Cependant, certains éléments de formatage et commentaires de code sont courants et nous les examinerons ci dessous. Comment formater votre code: À partir de là, nous donnerons quelques lignes directrices sur la façon de formater votre code pour une utilisation facile.
Mise en page: lrsquoindentation, le saut de ligne et le formatage avec la mise en page correcte aident à identifier les parties du Code qui sont ensemble, interdépendantes, et ainsi de suite. Les outils de base à cet égard sont lrsquoindentation, le saut de ligne et drsquoautres options de formatage. Voici comment les utiliser dans différents langages de programmation. HTML dans les balises HTML, indentez habituellement les éléments pour montrer qursquoils sont imbriqués les uns avec les autres.
Vous pouvez le faire en utilisant un onglet ou plusieurs espaces. Quelqursquoun en parle.
Lrsquoécriture est claire.
Enfin, voici un exemple de javascript: Const headingcolorui = MEMO (fonction ({textcolorvalue, settextcolor,}) {return
) } ) Vous pouvez voir les mêmes principes dans votre travail. Une autre partie de rendre le code lisible est drsquooptimiser son contenu. Il est important ici que ce que écrivez ait un sens et que les gens comprennent le rôle de chaque élément, fonction ou variable.
De cette façon, ils peuvent voir en un coup drsquooeil ce qursquoils font et où ils changent. Voici comment faire. Tout drsquoabord, utilisez des noms qui ne sont pas aléatoires, mais qui expliquent le rôle drsquoun morceau de code. Désinscrire la barre latérale (« droite de lrsquoen tête») Toute personne qui examine votre travail devrait être en mesure de comprendre immédiatement la fonctionnalité de chaque élément. Crois moi, si tu ne te joins pas à cette organisation, tu vas te faire botter le cul. Il nrsquoy a rien de pire que de srsquoénerver à cause de la paresse.
Comme nous lrsquoavons vu plus haut, les différents langages de programmation et de balisage ont des conventions différentes et il est logique de les respecter. En ce qui concerne les noms, en HTML et CSS, tout est généralement minuscule. Cela comprend le nom de lrsquoélément, lrsquoattribut, la valeur, le sélecteur, lrsquoattribut, ainsi que la classe et lrsquoID HTML. Cependant, comme nous lrsquoavons vu plus haut, tous les langages de programmation ne le sont pas. En PHP et Javascript, pouvez également voir des traits drsquounion dans CamelCase, sous _ score, ou sous score. Lequel est le bon? Ils fonctionnent tous les deux, donc il nrsquoy a pas de mauvaise solution (à lrsquoexception du trait drsquounion dans Javascript, qui peut conduire à la soustraction, donc ne les utilisez pas). Il est donc important que en décidiez un et que le respectiez. De plus, il est logique de voir les Conventions de la plateforme que utilisez. Par exemple, WordPress encourage l’utilisation de caractères soulignés en PHP et CamelCase en javascript. Par conséquent, si utilisez la plateforme wo
Crsquoest une bonne idée de srsquoen tenir à ces conventions, drsquoautant plus qursquoil y a beaucoup de variables existantes, etc. Ils sont déjà dans ce format. Avec tout ce qui précède, il est probable que chaque fois que drsquoautres développeurs regardent votre travail, ils peuvent rapidement comprendre ce qui se passe. Dans ce cas, votre code est ce que les gens appellent
Et lrsquoURI de licence V2 ou plus tard: http:www.gnu.orglicensesgpl-2.0.html Étiquettes: colonne, deux colonnes, barre latérale droite, titre flexible, accessibilité prête, couleurs personnalisées, Titre personnalisé, menu personnalisé, logo personnalisé, style d’éditeur, images en vedette, widgets de pied de page, format de message, support de langue RTL, messages collants, options de thème, notes de fil, traduction prête Ce thème (comme WordPress) est sous licence GPL. Utilisez le pour faire quelque chose de cool, srsquoamuser et partager ce que avez appris avec les autres * Utilisez un commentaire pour clarifier votre étiquette. Cependant, que devez en faire? Les commentaires sont conçus pour aider quiconque à comprendre le code qursquoil utilise. Cela inclut votre propre avenir (parce que ne souvenez peut être pas de ce que avez fait auparavant) ou quelqursquoun qui remplace. Pour cette raison, il est logique de laisser des informations sur ce qui se passe. Décrire le rôle drsquoune fonction ou drsquoun bloc de code particulier, à quoi appartient un segment de CSS, etc. Ajouter une nouvelle taille drsquoimage ajouter une taille drsquoimage (lsquoblogrsquo, 700300, vrai) De nombreux développeurs les utilisent également pour créer des tables de contenu pour leurs feuilles de style. Table des matières: 1.0 normalisation 2.0 accessibilité 3.0 alignement 4.0 effacement 5.0 mise en page 6.0 tableaux 7.0 formatage 8.0 listes 9.0 tableaux 10.0 liens 11.0 images en vedette en vol stationnaire 12.0 navigation 13.0 mise en page 13.1 en tête 13.2 accueil 13.3 contenu général 13.4 messages 13.5 page 13.6 pied de page 14.0 commentaires 15.0 widgets 16.0 médias 16.1 Galeries 17.0 personnalisateur 18.0 chutes SVG 19.0 requêtes des médias 20.0 impression 8212821282128212821282128212821282128212821282128212821282128212821282128212821282128212821282128212821282128212821282128212 De plus, établir une méthode qui contient des commentaires et qui ne srsquoécarte pas. Lrsquooutil de formatage de code se souvient de tout
travaillez en équipe, créer un guide de style peut aider à rester cohérent. Quels sont vos outils préférés pour formater le Code et les commentaires de code? Autre chose à ajouter? Veuillez nous en informer dans la section commentaires ci dessous.
