Introduction à la convention de dénomination en Java
Dans cet article, nous allons passer en revue certaines conventions de dénomination qui devraient ê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 en attribuant des noms à ses classes, variables ou méthodes ou interfaces, etc. et en faire une bonne pratique lors de l'écriture de codes. Les conventions de dénomination que nous aborderons dans cet article sont suggérées et pratiquées 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 cas de chameau est utilisé pour écrire les noms des méthodes / fonctions, des variables et le style de casse des titres pour les classes et les interfaces. Passons en revue et comprenons les règles à suivre pour nommer un élément / entité dans Java Programming Language:
- 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 majuscule.
Syntaxe: public class Employee ( //code snippet )
- Dans le cas des interfaces, il doit être un adjectif (qui décrit le nom (une classe qui l'implémente)) et commencer par une majuscule. Dans certains cas, un nom d'interface peut également être un nom, lorsqu'il représente une famille de classes, par exemple: 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 implémenter) et commencer par une lettre minuscule.
Syntaxe: void printDetails() ( //code snippet )
- Alors que pour les variables, elles doivent être significatives, ce qui signifie quel type d'informations elles stockent, que ce soit un nom, une adresse ou un numéro de téléphone, etc. Lorsque vous écrivez des noms de variables, nous devons nous assurer qu'elles ne commencez par des caractères spéciaux tels qu'un dollar ($) ou un caractère de soulignement (_) et son nom ne doit pas avoir d'espaces et commencez par une lettre minuscule.
Syntaxe: int eid, sal;string firstName, lastName;
- Les noms des variables constantes doivent être en majuscules (toutes en MAJUSCULES) et séparés par un signe de soulignement (_), leur nom est composé de plusieurs mots.
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 suivre la même convention de dénomination tout en nommant également nos packages.
Syntaxe: package src.employeedetails;
- Les énumérations dans votre code java doivent être en majuscule, 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 casse-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 de code d'application dans n'importe quel langage de programmation:
Exemple 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();
)
)
Production:
Exemple # 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 = " ";
)
// 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", " ");
cust.printDetails();
)
)
Sortie 1:
Sortie 2:
Avantages des conventions de dénomination Java
Voici quelques avantages de la convention d'appellation 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.
- Produisez un code cohérent tout au long de l'application.
Conclusion
La prochaine fois lors de l'écriture d'un code Java, assurez-vous que les classes, interfaces, packages, méthodes et champs que vous définissez et implémentez ont des noms qui suivent les conventions de dénomination Java. N'oubliez pas que les conventions de dénomination suivantes dans n'importe quel langage de programmation sont la première étape pour écrire du code propre et cohérent et sont probablement la première meilleure pratique que tout programmeur devrait suivre.
Articles recommandés
Ceci est un guide des conventions de dénomination Java. Nous discutons ici des classes, interfaces, packages, méthodes et champs qui définissent et implémentent les conventions de dénomination Java. Vous pouvez également consulter nos autres articles connexes pour en savoir plus -
- Objet en PHP
- Carrés en Java
- Récursivité en Java
- Factorial à Java
- Variables en JavaScript
- Tableaux en programmation Java
- Liste des packages R
- Méthodes de travail et Top 3 Enum en C #
- Guide complet de Factorial en C #