Conventions de dénomination Java

Dans cet article, nous passerons en revue certaines conventions de dénomination qui doivent être suivies, en particulier en Java à des fins de maintenabilité et de lisibilité du code, qui aident un programmeur à comprendre et à modifier le code écrit par un autre programmeur. Nous pouvons le considérer comme une ligne directrice que l’on peut suivre lors de l’attribution de noms à ses classes, variables, méthodes ou interfaces, etc. et en faire une bonne pratique lors de l’écriture de codes. Les conventions de dénomination dont nous discuterons dans cet article sont suggérées et mises en pratique par de nombreux programmeurs Java et également prises en charge par Netscape et Sun Microsystems.

Syntaxe dans les conventions de dénomination Java

Dans le langage de programmation Java, le style d'écriture en casse chameau est utilisé pour écrire les noms de méthodes/fonctions, les variables et le style de casse de titre pour les classes et les interfaces. Passons en revue et comprenons les règles à suivre lors de la nomination d'un élément/d'une entité dans le langage de programmation Java :

Commencez votre cours de développement de logiciels libres

Développement Web, langages de programmation, tests de logiciels et autres

• Lors de l'attribution de noms aux classes, nous devons garder à l'esprit que les noms de classe doivent être un nom et commencer par une lettre majuscule.

Syntaxe :

public class Employee { //code snippet }

• Dans le cas des interfaces, il doit s'agir d'un adjectif ab (qui décrit le nom (une classe qui l'implémente)) et commencer par une lettre majuscule. Dans certains cas, un nom d'interface peut également être un nom, lorsqu'il représente une famille de classes, ex : Map, List, etc.

Syntaxe :

interface Printable { //code snippet }

• Un nom de méthode doit commencer par un verbe (définissant une action que la méthode va mettre en œuvre) et commencer par une lettre minuscule.

Syntaxe :

void printDetails() { //code snippet }

• Alors que pour les variables, elles doivent avoir un sens, ce qui signifie quel type d'informations elles stockent, qu'il s'agisse d'un nom, d'une adresse, d'un numéro de téléphone, etc. Lors de l'écriture des noms de variables, nous devons nous assurer qu'elles ne commence pas par des caractères spéciaux tels qu'un dollar ($) ou un trait de soulignement (_) et son nom ne doit pas comporter d'espaces et commencer par une lettre minuscule.

Syntaxe :

int eid, sal;string firstName, lastName;

• Les noms des variables constantes doivent être entièrement en majuscules (tous en MAJUSCULES) et séparés par un signe de soulignement (_) ; son nom se compose de plus d'un mot.

Syntaxe :

static final int MIN_SAL = 20000;

• Nous savons que Java utilise toutes les lettres minuscules pour attribuer les noms de packages, et nous devons également suivre la même convention de dénomination lorsque nous nommons nos packages.

Syntaxe :

package src.employeedetails;

• Les énumérations dans votre code Java doivent être en majuscules, c'est-à-dire toutes les lettres majuscules.

Syntaxe :

enum JobPost { MANAGER, ANALYST, HR, ADMIN, ENGINEER }

• Les annotations en Java peuvent être un nom, un verbe ou un adjectif et doivent suivre le style de casse du titre pour nommer les annotations.

Syntaxe :

public @interface Documented {}

Exemples dans les conventions de dénomination Java

Maintenant, écrivons un code complet en utilisant les extraits de code ci-dessus qui le rendent plus significatif et nous aident à comprendre pourquoi les conventions de dénomination suivantes sont importantes lors de l'écriture du code d'application dans n'importe quel langage de programmation :

Exemple n°1

Code :

package src.employeedetails;
interface Printable {
void printDetails();  }
public class Employee implements Printable {
int eid;
double sal;
String firstName, lastName;
// Default Constructor
Employee() {
eid=0; sal=0.0;
firstName = "Anonymous"; lastName = "Anonymous";
}
// Parameterized Constructor
Employee(int eid, double sal, String firstName, String lastName) {
this.eid = eid; this.sal = sal;
this.firstName = firstName; this.lastName  = lastName;
}
public void printDetails() {
System.out.println("Employee ID:" + eid + "\n" +
"Employee First Name:" + firstName + "\n" +
"Employee Last Name:" + lastName + "\n" +
"Employee Salary:" + sal + "\n" );
}
public static void main(String args[]) {
Employee emp = new Employee(1,22368.50,"Alan","Hope");
emp.printDetails();
}
}

Sortie :

Exemple n°2

Code :

package src.customerdetails;
interface Printable { void printDetails(); }
public class Customer implements Printable {
int custid;
long mobNo;
String fullName,emailAddr;
// Default Constructor
Customer() {
custid=0; mobNo=0;
fullName = "Anonymous"; emailAddr = "[email protected]";
}
// Parameterized Constructor
Customer(int custid, long mobNo, String fullName, String   emailAddr) {
this.custid = custid; this.mobNo = mobNo;
this.fullName = fullName; this.emailAddr  = emailAddr;
}
public void printDetails() {
System.out.println("Customer ID:" + custid + "\n" +
"Customer Full Name:" + fullName + "\n" +
"Customer Email Address:" + emailAddr + "\n" +
"Customer Mobile Number:" + mobNo + "\n" );
}
public static void main(String args[]) {
Customer cust = new Customer (1,987451036,"Alan Hope","[email protected]");
cust.printDetails();
}
}

Sortie 1 :

Sortie 2 :

Avantages des conventions de dénomination Java

Vous trouverez ci-dessous quelques avantages de la convention de dénomination Java :

• Réduction de la confusion dans l'écriture ou du code erroné.
• Amélioration de la lisibilité du code.
• Moins de temps passé à comprendre ce que fait le code.
• Amélioration de la maintenabilité du code.
• Produire un code cohérent dans toute l'application.

Conclusion

La prochaine fois que vous écrivez un code Java, assurez-vous que les classes, interfaces, packages, méthodes et champs que vous définissez et implémentez portent des noms suivant les conventions de dénomination Java. N'oubliez pas que les conventions de dénomination suivantes dans n'importe quel langage de programmation constituent la première étape pour écrire un code propre et cohérent et constituent probablement la première bonne pratique que tout programmeur devrait suivre.

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!