Wprowadzenie do konwencji nazewnictwa w Javie
W tym artykule omówimy niektóre konwencje nazewnictwa, których należy przestrzegać, szczególnie w Javie w celu zachowania i czytelności kodu, które pomagają programiście zrozumieć i zmodyfikować kod napisany przez innego programistę. Możemy uznać to za wskazówkę, którą należy przestrzegać, przypisując nazwy do swoich klas, zmiennych, metod lub interfejsów itp. I czynić to dobrą praktyką podczas pisania kodów. Konwencje nazewnictwa, które omówimy w tym artykule, są sugerowane i praktykowane przez wielu programistów Java, a także obsługiwane przez Netscape i Sun Microsystems.
Składnia w konwencjach nazewnictwa Java
W języku programowania Java styl pisania wielkimi literami jest używany do pisania nazw metod / funkcji, zmiennych i stylu wielkich liter dla klas i interfejsów. Przyjrzyjmy się zasadom, których należy przestrzegać, nazywając element / byt w języku programowania Java:
- Przypisując nazwy do klas, należy pamiętać, że nazwy klas powinny być rzeczownikiem i zaczynać od dużej litery.
Składnia: public class Employee ( //code snippet )
- W przypadku interfejsów powinien być przymiotnikiem (który opisuje rzeczownik (klasa, która go implementuje)) i zaczynać wielką literą. W niektórych przypadkach nazwa interfejsu może być również rzeczownikiem, gdy reprezentuje rodzinę klas, np .: Mapa, Lista itp.
Składnia: interface Printable ( //code snippet )
- Nazwa metody powinna rozpoczynać się od czasownika (definiującego akcję, którą metoda ma zamiar zrealizować) i zaczynać się od małej litery.
Składnia: void printDetails() ( //code snippet )
- Natomiast w przypadku zmiennych powinny one mieć znaczenie, co oznacza, jakie informacje przechowują, czy jest to nazwa, adres, numer telefonu itp. Pisząc nazwy zmiennych, musimy upewnić się, że nie zaczynają się od znaków specjalnych, takich jak znak dolara ($) lub znak podkreślenia (_), a jego nazwa nie powinna zawierać żadnych białych znaków i zaczyna się małą literą.
Składnia: int eid, sal;string firstName, lastName;
- Nazwy zmiennych stałych powinny być pisane wielką literą (wszystkie wielkie litery) i oddzielone znakiem podkreślenia (_), jego nazwa składa się z więcej niż jednego słowa.
Składnia: static final int MIN_SAL = 20000;
- Wiemy, że Java używa wszystkich małych liter do przypisywania nazw pakietów i powinniśmy przestrzegać tej samej konwencji nazewnictwa, jednocześnie nazywając nasze pakiety.
Składnia: package src.employeedetails;
- Wyliczenia w kodzie Java powinny być pisane wielkimi literami, tzn. Wszystkie wielkie litery.
Składnia: enum JobPost ( MANAGER, ANALYST, HR, ADMIN, ENGINEER )
- Adnotacje w języku Java mogą być rzeczownikiem, czasownikiem lub przymiotnikiem i powinny nazywać się tytułem tytułów w celu nazywania adnotacji.
Składnia: public @interface Documented ()
Przykłady w konwencjach nazewnictwa Java
Teraz napiszmy pełny kod przy użyciu powyższych fragmentów kodu, co czyni go bardziej znaczącym i pomaga zrozumieć, dlaczego przestrzeganie konwencji nazewnictwa jest ważne podczas pisania kodu aplikacji w dowolnym języku programowania:
Przykład 1
Kod:
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();
)
)
Wynik:
Przykład nr 2
Kod:
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();
)
)
Wyjście 1:
Wyjście 2:
Zalety konwencji nazewnictwa Java
Poniżej przedstawiono niektóre zalety konwencji nazewnictwa Java:
- Zmniejszenie nieporozumień w pisaniu lub błędnego kodu.
- Poprawa czytelności kodu.
- Mniej czasu poświęconego na zrozumienie działania kodu.
- Poprawa w utrzymywalności kodu.
- Utwórz spójny kod w całej aplikacji.
Wniosek
Następnym razem podczas pisania kodu Java upewnij się, że zdefiniowane i zaimplementowane klasy, interfejsy, pakiety, metody i pola mają nazwy zgodne z konwencjami nazewnictwa Java. Pamiętaj, że przestrzeganie konwencji nazewnictwa w dowolnym języku programowania jest pierwszym krokiem do napisania czystego i spójnego kodu i prawdopodobnie pierwszą najlepszą praktyką, którą powinien stosować każdy programista.
Polecane artykuły
Jest to przewodnik po konwencjach nazewnictwa Java. Tutaj omawiamy klasy, interfejsy, pakiety, metody i pola, które definiują i implementują konwencje nazewnictwa Java. Możesz również przejrzeć nasze inne powiązane artykuły, aby dowiedzieć się więcej -
- Obiekt w PHP
- Kwadraty w Javie
- Rekurencja w Javie
- Silnia w Javie
- Zmienne w JavaScript
- Tablice w programowaniu Java
- Lista pakietów R.
- Praca i 3 najlepsze metody wyliczania w C #
- Kompletny przewodnik po silniku w C #