Java-naamgevingsconventies gebruiken

Een naamgevingsconventie is een regel die moet worden gevolgd bij het bepalen van de naam van uw id's (bijvoorbeeld klasse, pakket, variabele, methode, enz.).

Waarom naamgevingsconventies gebruiken?

Verschillende Java-programmeurs kunnen verschillende stijlen en benaderingen hebben in de manier waarop ze programmeren. Door standaard Java-naamgevingsconventies te gebruiken, maken ze hun code gemakkelijker leesbaar voor zichzelf en voor andere programmeurs. De leesbaarheid van Java-code is belangrijk omdat het betekent dat er minder tijd wordt besteed aan proberen te achterhalen wat de code doet, waardoor er meer tijd overblijft om het te repareren of te wijzigen.

Om het punt te illustreren dat het vermelden waard is dat de meeste softwarebedrijven een document hebben dat de naamgevingsconventies schetst die zij willen dat hun programmeurs volgen. Een nieuwe programmeur die bekend raakt met die regels, kan de code begrijpen die is geschreven door een programmeur die het bedrijf mogelijk al vele jaren van tevoren heeft verlaten.

Een naam kiezen voor uw ID

Let er bij het kiezen van een naam voor een ID op dat deze betekenisvol is. Als uw programma bijvoorbeeld klantaccounts behandelt, kiest u namen die logisch zijn voor het omgaan met klanten en hun accounts (bijvoorbeeld klantnaam, accountgegevens). Maak je geen zorgen over de lengte van de naam. Een langere naam die de identifier perfect samenvat, verdient de voorkeur boven een kortere naam die misschien snel te typen maar dubbelzinnig is.

Enkele woorden over zaken

Het gebruik van de juiste letter is de sleutel tot het volgen van een naamgevingsconventie:

  • kleine letters is waar alle letters in een woord worden geschreven zonder hoofdletters (bijvoorbeeld terwijl, als mijn pakket).
  • hoofdletters is waar alle letters van een woord in hoofdletters worden geschreven. Wanneer de naam meer dan twee woorden bevat, gebruikt u onderstrepingstekens om ze te scheiden (bijvoorbeeld MAX_HOURS, FIRST_DAY_OF_WEEK).
  • CamelCase (ook bekend als Upper CamelCase) is waar elk nieuw woord begint met een hoofdletter (bijvoorbeeld CamelCase, CustomerAccount, PlayingCard).
  • Gemengde zaak (ook bekend als Lower CamelCase) is hetzelfde als CamelCase, behalve dat de eerste letter van de naam in kleine letters staat (bijvoorbeeld hasChildren, customerFirstName, customerLastName).

Standaard Java-naamgevingsconventies

De onderstaande lijst geeft de standaard Java-naamgevingsconventies voor elk ID-type:

  • Pakketjes: Namen moeten kleine letters zijn. Met kleine projecten die slechts een paar pakketten hebben, is het prima om ze eenvoudige (maar betekenisvolle!) Namen te geven:
     pakket pokeranalyzer pakket mycalculator 
    In softwarebedrijven en grote projecten waar de pakketten in andere klassen kunnen worden geïmporteerd, worden de namen normaal gesproken onderverdeeld. Meestal begint dit met het bedrijfsdomein voordat het wordt opgesplitst in lagen of functies:
     pakket com.mycompany.utilities pakket org.bobscompany.application.userinterface 
  • Klassen: Namen moeten in CamelCase zijn. Probeer zelfstandige naamwoorden te gebruiken omdat een klasse normaal iets in de echte wereld vertegenwoordigt:
     klasse Klantklasse Account 
  • interfaces: Namen moeten in CamelCase zijn. Ze hebben meestal een naam die een bewerking beschrijft die een klasse kan uitvoeren:
     interface Vergelijkbare interface Telbaar 
    Merk op dat sommige programmeurs graag onderscheid maken door de naam te beginnen met een "I":
     interface ICvergelijkbare interface 
  • methoden: Namen moeten in een gemengd geval staan. Gebruik werkwoorden om te beschrijven wat de methode doet:
     void berekenTax () string getS achternaam () 
  • Variabelen: Namen moeten in een gemengd geval staan. De namen moeten vertegenwoordigen wat de waarde van de variabele vertegenwoordigt:
     string firstName int orderNumber 
    Gebruik alleen zeer korte namen wanneer de variabelen van korte duur zijn, zoals in voor lussen:
     voor (int i = 0; i<20;i++)    //i only lives in here  
  • constanten: Namen moeten in hoofdletters zijn.
     statische finale int DEFAULT_WIDTH statische finale int MAX_HEIGHT