Innehållsförteckning
När du börjar lära dig ett nytt programmeringsspråk är det viktigt att känna till dess bästa praxis, eftersom ett bra program inte bara är en väl utförd algoritm utan också dokumentation Och vägen in vad är koden skriven är viktigt.Om vi dokumenterar bra kommer vi att kunna lämna de programmerare som granskar vår kod på ett bra sätt så att de förstår vad vi gjorde och anledningarna, på så sätt är kontinuiteten i projekten bättre; också en läsbar kod hjälper oss att felsöka fel och gör att vi kan slösa mindre tid på olika faktorer än att uppnå våra mål.
Namnkonvention
Namnkonventionen är oerhört viktig, med detta kan vi snabbt identifiera klass- och metodvariabler.
Den första viktiga aspekten är namnens skrivstil, när vi har variabelnamn vi måste använda gemener och när vi har konstanter måste vara med versaler, låt oss se:
int [b] divisor [/ b] = 5; slutlig dubbel [b] PI [/ b] = 3,14;
Så när vi ser PI kommer vi att veta att det är en konstant, å andra sidan om vi ser en divisor vet vi att det är en variabel och om vi behöver manipulera det kan vi göra det med vetskap om att vi inte kommer att påverka programmet.
Om vi har namn på flera ord måste vi använda kamelhusmetod det vill säga, versera den första bokstaven i följande ord i namnet.
Låt oss titta på följande exempel:
På bilden kan vi se hur vi definierar en klass med flera ord, i fallet med klasser, upp till det första ordet måste börja med stora bokstäver.
Utrymme och identitet
När vi skriver kapslad kod, till exempel klasser och deras metoder, måste dessa gå indragna, det vill säga, de måste separeras med en flik för att beteckna deras häckning, med detta underlättar vi identifieringen av vilka delar som tillhör vilka.
Vi måste också ta hand om utrymmet mellan de olika elementen som utgör deklarationerna, eftersom missbruk kan ge ett läsbarhetsproblem.
Låt oss se ett exempel på varje sak, till exempel utrymmet mellan element, i bilden ser vi rätt form i den nedre delen, där varje element är åtskilt av ett mellanslag, men i den övre delen på fel sätt ser vi att det finns är ingen enhetlighet i utrymmena.
I nästa graf ser vi hur man gör ett block med a Bra indrag, kan vi märka hur varje element är kapslat och åtskilt av ett radbrytning.
Dokumentation
Som vi nämnde i början av dokumentation tillåter oss att ange våra kommentarer inom koden, för detta kommer vi att använda skrivverktygen kommentarer i Java; Om vi till exempel vill dokumentera varje steg vi utför inom koden kan vi använda // för att generera en rad som kommer att utelämnas av kompilatorn men som kan läsas från källfilen.
Om vi i början av klassen gör ett kommentarsblock med:
/** /* /* **/
Det vi skriver inuti det blocket kan exporteras och användas för att generera HTML -dokument med verktygen för java -dokumentation. Så vi måste använda varje fall därefter.
I slutet av handledningen har vi en bredare uppfattning om bästa praxis när vi gör Java -program för att samarbeta med utveckling på en funktionsnivå men gå lite bortom vårt ansvar som en bra utvecklare.Gillade du och hjälpte denna handledning?Du kan belöna författaren genom att trycka på den här knappen för att ge honom en positiv poäng