Convention de dénomination du développement de projets Java (disposition des nœuds de puissance)

Le but de la définition de cette spécification est de donner l'impression que tous les documents du projet ont été rédigés par une seule personne, d'augmenter la lisibilité et de réduire les pertes causées par les substitutions au sein de l'équipe de projet. Permettez-moi de partager avec vous la convention de dénomination du développement Java. Jetons un coup d'œil

Il est préférable d'utiliser l'anglais au lieu du pinyin chinois

. 1 : Package ( package) : utilisé pour classer les classes qui remplissent différentes fonctions et les placer dans différents répertoires (packages). Les règles de dénomination du package : inverser le nom de domaine de l'entreprise comme nom du package. Par exemple, www.bjpowernode.com Pour les noms de packages : chaque lettre doit être en minuscule. Par exemple : com. bjpowernode.test ; le nom complet de la classe Test sous ce package est : com. Si un package n'est pas utilisé lors de la définition d'une classe, Java pensera que la classe que nous avons définie est dans le package par défaut.

2 : Classe : La première lettre est en majuscule. Si une classe est composée de plusieurs mots, alors la première lettre de chaque mot est en majuscule et aucun connecteur n'est utilisé au milieu. Utilisez l'anglais autant que possible. Par exemple, ConnectionFactory

3 : Méthode : Le premier mot est entièrement en minuscules. Si une méthode se compose de plusieurs mots, la première lettre est en majuscule à partir du deuxième mot et les connecteurs ne sont pas utilisés. addPerson

4 : Attributs : Identique à la méthode. Par exemple, ageOfPerson

5 : Constant : Les lettres de tous les mots sont en majuscules. S'il y a plusieurs mots, utilisez simplement les liens soulignés.

Par exemple :

public static final int AGE_OF_PERSON = 20; //通常加上static

Supplémentaire : Faites attention aux points suivants lorsque vous nommez des variables :

· Choisissez un nom significatif, en veillant à mettre en majuscule la première lettre de chaque mot.

· N'utilisez pas la même variable pour représenter deux valeurs avec des significations différentes dans une fonction .

· i, j, k, etc. ne sont utilisés que comme variables d'index de boucle pour les petites boucles.

· Évitez d'utiliser Flag pour nommer les variables d'état.

· Utilisez Is pour nommer des variables logiques, telles que : blnFileIsFound. En nommant les variables booléennes de manière positive, les autres développeurs peuvent comprendre plus clairement la signification des variables booléennes.

· Si nécessaire, ajoutez un qualificatif de calcul à la fin de la variable, tel que : curSalesSum.

· Les noms ne sont pas inclusifs, curSales et curSalesSum.

· Les noms des variables finales statiques (constantes) doivent être en majuscules et la signification complète doit être indiquée.

· Si vous devez abréger le nom de la variable , vous devez faire attention à la cohérence des règles d'abréviation dans tout le code. Par exemple, si vous utilisez intCnt dans certaines zones de votre code et intCount dans d'autres, vous ajouterez une complexité inutile à votre code. Il est recommandé d'éviter les abréviations dans les noms de variables.

· En ​​plaçant un quantificateur à la fin, vous créez des variables plus uniformes qui sont plus faciles à comprendre et à rechercher. Par exemple, utilisez strCustomerFirst et strCustomerLast au lieu de strFirstCustomer et strLastCustomer. Les suffixes de quantificateurs couramment utilisés sont : First (le premier d'un groupe de variables), Last (le dernier d'un groupe de variables), Suivant (la variable suivante d'un groupe de variables), Précédent (variable précédente dans un ensemble de variables), Cur (variable actuelle dans un ensemble de variables).

· Choisissez le meilleur type de données pour chaque variable, ce qui peut réduire les besoins en mémoire, accélérer l'exécution du code et réduire le risque d'erreurs. Le type de données utilisé pour une variable peut affecter les résultats des calculs effectués sur cette variable. Dans ce cas, le compilateur ne génère pas d'erreur d'exécution, il force simplement la valeur à se conformer aux exigences du type de données. Ces types de problèmes sont extrêmement difficiles à trouver.

· Essayez de réduire la portée des variables autant que possible. Si la portée d'une variable est plus grande qu'elle ne devrait l'être, la variable peut continuer à exister et occuper des ressources longtemps après qu'elle ne soit plus nécessaire. Le principal problème avec eux est qu'ils peuvent être modifiés par n'importe quelle méthode dans n'importe quelle classe, et il est difficile de savoir exactement où la modification a été effectuée. L’occupation des ressources est une question importante liée à la portée. Pour les variables, garder la portée aussi petite que possible aura un impact énorme sur la fiabilité de l'application.

Concernant la méthode de dénomination des constantes, dans le code JAVA, il est recommandé d'utiliser des constantes pour remplacer les nombres et les chaînes fixes à tout moment. En d’autres termes, à l’exception de 0 et 1, d’autres nombres ne doivent pas apparaître autant que possible dans le programme. Les constantes peuvent être définies au début du programme ou dans une portée plus large. Les noms doivent tous utiliser des lettres majuscules et indiquer la signification complète de la constante. Si un nom de constante est composé de plusieurs mots, les mots doivent être séparés par un trait de soulignement "_", tel que : NUM_DAYS_IN_WEEK, MAX_VALUE.

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!