Úvod do Naming Convention v Javě

V tomto článku projdeme některé pojmenovací konvence, které by měly být dodržovány zejména v Javě pro účely udržování a čitelnosti kódu, které pomáhají programátorovi porozumět a upravit kód napsaný jiným programátorem. Můžeme to považovat za vodítko, které lze dodržovat při přiřazování jmen jednotlivým třídám, proměnným nebo metodám nebo rozhraním atd. A při psaní kódů je to dobrý postup. Konvence pojmenování, o nichž budeme hovořit v tomto článku, jsou navrženy a praktikovány mnoha programátory Java a podporovány také Netscape a Sun Microsystems.

Syntaxe v Java Naming Convention

V programovacím jazyce Java se styl psaní velbloudího písma používá pro psaní názvů metod / funkcí, proměnných a stylu titulků pro třídy a rozhraní. Pojďme se seznámit s pravidly, která by se měli řídit při pojmenování prvku / entity v programovacím jazyce Java:

  • Při přiřazování jmen třídám bychom měli mít na paměti, že názvy tříd by měly být podstatné jméno a začínat velkým písmenem.

Syntaxe: public class Employee ( //code snippet )

  • V případě rozhraní by to mělo být přídavné jméno (které popisuje podstatné jméno (třída, která jej implementuje)) a začínající velkým písmenem. V některých případech může být jméno rozhraní také substantivum, pokud reprezentuje rodinu tříd, např .: Mapa, Seznam atd.

Syntaxe: interface Printable ( //code snippet )

  • Název metody by měl začínat slovesem (definujícím akci, kterou má metoda implementovat) a začínat malým písmenem.

Syntaxe: void printDetails() ( //code snippet )

  • Zatímco pro proměnné by měly být smysluplné, což znamená, jaký druh informací se ukládá, ať už se jedná o jméno, adresu, telefonní číslo atd. Při psaní názvů proměnných se musíme ujistit, že ne začínají speciálními znaky, jako je například dolar ($) nebo znak podtržítka (_) a jeho název by neměl mít žádné mezery a začínat malým písmenem.

Syntaxe: int eid, sal;string firstName, lastName;

  • Názvy konstantních proměnných by měly být plně kapitalizovány (všechny UPPERCASE) a oddělené znakem podtržítka (_), jehož název se skládá z více než jednoho slova.

Syntaxe: static final int MIN_SAL = 20000;

  • Víme, že Java používá k přiřazování názvů balíků všechna malá písmena a při pojmenovávání našich balíčků bychom měli dodržovat stejnou konvenci pojmenování.

Syntaxe: package src.employeedetails;

  • Výpočty ve vašem kódu java by měly být velkými písmeny, tj. Všechna velká písmena.

Syntaxe: enum JobPost ( MANAGER, ANALYST, HR, ADMIN, ENGINEER )

  • Anotace v java mohou být substantivum, sloveso nebo přídavné jméno a pro pojmenování anotací by se měly řídit stylem case-case.

Syntaxe: public @interface Documented ()

Příklady v názvových konvencích Java

Nyní nám dovolte napsat úplný kód pomocí výše uvedených fragmentů kódu, což z něj dělá smysluplnější a pomůže nám pochopit, proč jsou při psaní kódu aplikace v libovolném programovacím jazyce důležité následující konvence pojmenování:

Příklad č. 1

Kód:

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();
)
)

Výstup:

Příklad č. 2

Kód:

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();
)
)

Výstup 1:

Výstup 2:

Výhody Java Naming Convention

Níže jsou uvedeny některé výhody konvence pojmenování java:

  • Snížení psaného zmatku nebo chybného kódu.
  • Zlepšení čitelnosti kódu.
  • Méně času stráveného přijetím na to, co kód dělá.
  • Vylepšení v udržovatelnosti kódu.
  • Vytvořte konzistentní kód v celé aplikaci.

Závěr

Při příštím psaní kódu Java se ujistěte, že třídy, rozhraní, balíčky, metody a pole, která definujete a implementujete, mají jména, která odpovídají konvencím pojmenování Java. Pamatujte si, že následující konvence pojmenování v jakémkoli programovacím jazyce jsou prvním krokem k napsání čistého a konzistentního kódu a je pravděpodobně prvním doporučeným postupem, který by měl dodržovat každý programátor.

Doporučené články

Toto je průvodce Java Naming Convention. Zde diskutujeme třídy, rozhraní, balíčky, metody a pole, které definují a implementují konvence pojmenování Java. Další informace naleznete také v dalších souvisejících článcích -

  1. Objekt v PHP
  2. Čtverce v Javě
  3. Rekurze v Javě
  4. Factorial v Javě
  5. Proměnné v JavaScriptu
  6. Pole v programování Java
  7. Seznam R balíčků
  8. Pracovní a top 3 metody výčtu v C #
  9. Kompletní průvodce faktorem v C #

Kategorie:

Vývoj softwaru