Comment écrire du code lisible en php

Les équipes de développement performantes exigent que chaque membre de l'équipe respecte les règles de réutilisation du code. Ces règles poussent la réutilisabilité du code à l'extrême sans réduire de manière significative la créativité et l'efficacité de développement des développeurs. Si les développeurs qui écrivent et utilisent le code adhèrent aux conventions communes de dénomination des programmes et aux exigences du code commentaire , la réutilisabilité du code sera grandement améliorée. Le point de départ de ces normes se situe au niveau de l’architecture du système. Votre spécification fonctionnelle doit refléter ces normes dans la définition des classes, des noms de attributs, des valeurs de retour de fonction et d'autres éléments clés du programme. Cet article fournira quelques suggestions pratiques sur les règles de dénomination de base et des commentaires, dans le but d'aider les lecteurs à développer leurs propres normes de réutilisation de code.

Normes de cas

Avant de commencer à discuter de la manière correcte de nommer divers éléments de programme, définissons les deux manières les plus courantes de distinguer la casse des éléments :
<.>Spécification Pascal : le premier caractère est en majuscule et la première lettre de chaque mot du nom cible est également en majuscule, comme InvoiceNumber ou PrintInvoice. Tous les autres caractères sont en minuscules.
Spécification Camel : le premier caractère n'est pas en majuscule, mais la première lettre de chaque mot du nom cible est en majuscule, par exemple, BillNumber. Tous les autres caractères sont en minuscules.
Cependant, l'utilisation de la casse des caractères pour distinguer les éléments peut causer des problèmes dans les
langages de programmation insensibles à la casse. Par exemple, étant donné que le langage C# est sensible à la casse, vous pouvez appeler la variable privée Employee, puis sa propriété publique Employee peut être utilisée par l'appelant. Ces opérations sont tout à fait légales. Cependant, une erreur se produira pour Visual Basic, car VB n'est pas sensible à la casse et les deux éléments ci-dessus sont la même chose aux yeux de VB. Si vous travaillez dans un environnement multilingue, vous ne pouvez spécifier que certaines règles qui obligent les développeurs à utiliser raisonnablement plusieurs langages pour lire le code développé par d'autres.

Normes de dénomination
En supposant que nous adoptons les normes de cas ci-dessus, examinons maintenant quelques suggestions de dénomination simples pour les éléments de programme courants.

Classes
Certaines classes sont conçues pour simuler des objets du monde réel. Pour ces classes, les noms choisis doivent refléter les objets du monde réel, avec des noms singuliers, tels que Employé, Facture ou Feuille de temps, etc. Pour les classes internes, la spécification Pascal peut être utilisée pour donner à la classe résultat un nom singulier, tel que ThreadPool ou CustomColor, etc. Les classes doivent être au singulier afin que leur forme plurielle puisse représenter des noms de collections du même type, comme le tableau Employees, etc.

Membres d'une classe
Les développeurs utilisant C# et d'autres langages de programmation sensibles à la casse doivent utiliser la convention camel pour nommer les membres de la classe. Cela permet aux développeurs de faire plus facilement la distinction entre les noms des variables internes et les noms des propriétés publiques. De nombreux développeurs VB préfèrent utiliser la nomenclature hongroise pour nommer les membres de la classe, c'est-à-dire ajouter un préfixe devant le nom pour indiquer le type de la variable. Par exemple, sName fait référence à la variable Name de type
string. . Je pense qu'il n'est pas nécessaire de faire cela dans un environnement de développement avancé tel que VS.NET, car dans ce cas, le type de variable du système peut être automatiquement affiché en passant la souris sur la variable. Personnellement, j'aime préfixer les noms des membres de la classe avec la lettre minuscule m. De cette façon, la variable interne enregistre suffisamment d'informations de classe interne : la variable interne mName représente simplement le nom de l'attribut public.
Méthodes
Les méthodes doivent être nommées selon la spécification Pascal et décrire leur comportement d'implémentation de manière raisonnable. Par exemple, la méthode d'ajout d'employés à la base de données peut être nommée AddEmployee et la méthode d'impression des factures peut être nommée PrintInvoice. Si la méthode renvoie une valeur booléenne, le nom de la méthode doit commencer par un verbe afin que sa signification soit plus évidente lorsqu'elle est utilisée dans une instruction if. Par exemple, si vous disposez d'une méthode qui détermine si un employé répond aux exigences du plan 401k de l'entreprise, vous pouvez appeler la méthode IsEligible401k dans une instruction If : If IsEligible401k then...

Paramètres de la méthode, valeur de retour , et variables
Tous les paramètres de méthode, valeurs de retour et variables doivent être nommés conformément aux spécifications Pascal. Comme les noms de méthode, ils doivent également refléter la signification des paramètres ou des variables. Ceci est particulièrement important pour les méthodes avec paramètres, car Intellisense renvoie le nom et le type du paramètre lorsque vous appelez la méthode. Tous les développeurs utilisant des méthodes doivent utiliser des noms et des types descriptifs afin que leur signification soit mutuellement comprise.

Contrôles
La dénomination des contrôles est une question souvent controversée dans le monde du développement. Bien que la plupart des gens conviennent que les noms de contrôle par défaut ne doivent pas être utilisés, tels que TextBox1 ou Label1, etc., ils s'opposent également à nommer les contrôles en tant que variables ou à utiliser des préfixes pour indiquer le type de contrôle. Je préfère utiliser le préfixe standard à trois lettres pour nommer les contrôles sur un formulaire. Par exemple, les contrôles de zone de texte qui stockent le prénom et le nom peuvent être nommés respectivement txtLastName et txtFirstName. Le bouton de commande qui traite les données du formulaire peut être nommé cmdSubmit ou cmdCancel. En fait, tant que vous pouvez vous assurer que la dénomination des contrôles est cohérente et que la norme est facile à comprendre.

Commentaires
Le code de commentaire est nécessaire pour tous les développeurs. Afin d'enseigner les techniques d'annotation appropriées, j'ajoute souvent du code annoté à mes programmes de démonstration. De plus, pour simplifier le processus d'annotation, je recommande aux développeurs d'écrire d'abord des commentaires décrivant le programme qu'ils souhaitent écrire. J'écrirai d'abord des commentaires pour décrire les procédures, les classes ou d'autres éléments du programme, mais je n'expliquerai pas comment ils fonctionnent. Ensuite, j'écrirais une série de code commenté décrivant chaque étape majeure du processus ou élément de la classe. Après avoir écrit le code qui définit la classe ou décrit le processus, je documente chaque variable externe, contrôle, fichier ouvert et même les éléments accessibles par d'autres processus, et j'explique brièvement les paramètres d'entrée et les valeurs de retour.

Si vous développez un programme en C#, l'environnement VS.NET dispose déjà d'outils intégrés pour vous aider à convertir les commentaires C# internes en documents HTML externes. Vous pouvez ajouter des directives de traitement spéciales à votre propre document pour modifier la façon dont le document externe est représenté. Pour plus d'informations à ce sujet, veuillez vous référer au fichier d'aide interne de VS.NET : ms-help://MS.VSCC/MS.MSDNVS/csref/html/vcoriXMLDocumentation.htm
.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!