Använda Java Naming Conventions

En namnkonvention är en regel att följa när du bestämmer vad du ska namnge dina identifierare (t.ex. klass, paket, variabel, metod etc.).

Varför använda namnkonventioner?

Olika Java-programmerare kan ha olika stilar och metoder för hur de programmerar. Genom att använda vanliga Java-namnkonventioner gör de sin kod lättare att läsa för sig själva och för andra programmerare. Java-kodens läsbarhet är viktigt eftersom det innebär att mindre tid läggs på att försöka ta reda på vad koden gör, vilket ger mer tid att fixa eller ändra den.

För att illustrera punkten är det värt att nämna att de flesta mjukvaruföretag kommer att ha ett dokument som beskriver namnskonventionerna som de vill att deras programmerare ska följa. En ny programmerare som blir bekant med dessa regler kan förstå koden skriven av en programmerare som kan ha lämnat företaget många år i förväg.

Välj ett namn för din identifierare

När du väljer ett namn för en identifierare, se till att det är meningsfullt. Om ditt program till exempel hanterar kundkonton väljer du namn som är vettigt för att hantera kunder och deras konton (t.ex. kundnamn, kontodetaljer). Oroa dig inte för längden på namnet. Ett längre namn som sammanfattar identifieraren perfekt är att föredra framför ett kortare namn som kan vara snabbt att skriva men tvetydigt.

Några ord om fall

Att använda rätt bokstav är nyckeln till att följa en namnkonvention:

• Små bokstäver är där alla bokstäver i ett ord skrivs utan stora bokstäver (t.ex. medan, om, mypackage).
• Versal är där alla bokstäver i ett ord skrivs med huvudstäder. När det finns mer än två ord i namnet använder du understreck för att separera dem (t.ex. MAX_HOURS, FIRST_DAY_OF_WEEK).
• Camelcase (även känd som Upper CamelCase) där varje nytt ord börjar med en stor bokstav (t.ex. CamelCase, CustomerAccount, PlayingCard).
• Blandat fall (även känd som Lower CamelCase) är samma som CamelCase förutom att den första bokstaven i namnet är med små bokstäver (t.ex. hasChildren, customerFirstName, customerLastName).

Standard Java-namnkonventioner

Listan nedan beskriver standardnamn för Java-namngivning för varje identifieringstyp:

• paket: Namnen ska vara små. Med små projekt som bara har några paket är det okej att bara ge dem enkla (men meningsfulla!) Namn:

   paket pokeranalyzer paket mycalculator 

  I mjukvaruföretag och stora projekt där paketen kan importeras till andra klasser kommer namnen normalt att delas upp. Vanligtvis börjar detta med företagets domän innan det delas upp i lager eller funktioner:

   paket com.mycompany.utilities paket org.bobscompany.application.userinterface 

• Klasser: Namnen ska finnas i CamelCase. Försök att använda substantiv eftersom en klass normalt representerar något i den verkliga världen:

   klass Kundklass Konto 

• gränssnitt: Namnen ska finnas i CamelCase. De tenderar att ha ett namn som beskriver en operation som en klass kan göra:

   gränssnitt Jämförbart gränssnitt Antal 

  Observera att vissa programmerare gillar att skilja gränssnitt genom att börja namnet med ett "jag":

   gränssnitt IC Comparable interface IEnumerable 

• metoder: Namnen ska vara i blandade fall. Använd verb för att beskriva vad metoden gör:

   void calculTax () sträng getSname () 

• variabler: Namnen ska vara i blandade fall. Namnen ska representera vad värdet på variabeln representerar:

   string firstName int orderNumber 

  Använd bara mycket korta namn när variablerna är kortlivade, till exempel i för slingor:

   för (int i = 0; i<20;i++)    //i only lives in here  

• Konstanter anter~~POS=HEADCOMP: Namnen bör vara stora och stora.

   statisk slutlig int DEFAULT_WIDTH statisk slutlig int MAX_HEIGHT