Inhoudsopgave
Wanneer u begint met het leren van een nieuwe programmeertaal, is het belangrijk om de best practices te kennen, aangezien een goed programma niet alleen een goed uitgevoerd algoritme is, maar ook de documentatie En de weg naar binnen wat is de code geschreven? zijn belangrijk.Als we goed documenteren, kunnen we de programmeurs die onze code beoordelen op een goede manier achterlaten, zodat ze begrijpen wat we hebben gedaan en de redenen, op deze manier is de continuïteit van de projecten beter; ook een leesbare code helpt ons om fouten te debuggen en zorgt ervoor dat we minder tijd kunnen verspillen aan verschillende factoren dan het behalen van onze doelen.
Naamgeving
De naamgevingsconventie is uiterst belangrijk, hiermee kunnen we in één oogopslag identificeren klasse- en methodevariabelen.
Het eerste belangrijke aspect is de schrijfstijl van de namen, als we namen van variabelen hebben we moeten kleine letters gebruiken en als we constanten hebben moet in hoofdletters zijn, laten we kijken:
int [b] deler [/ b] = 5; laatste dubbele [b] PI [/ b] = 3,14;
Dus als we PI zien, weten we dat het een constante is, aan de andere kant als we een deler zien, weten we dat het een variabele is en als we het moeten manipuleren, kunnen we het doen wetende dat we het programma niet zullen beïnvloeden.
Als we namen hebben van meerdere woorden, moeten we de gebruiken kameel geval methode: dat wil zeggen, gebruik de eerste letter van de volgende woorden van de naam met een hoofdletter.
Laten we eens kijken naar de volgende voorbeelden:
Ruimte en identificatie
Wanneer we geneste code schrijven, bijvoorbeeld klassen en hun methoden, moeten deze gaan ingesprongen, dat wil zeggen, ze moeten worden gescheiden met een tab om hun nesting aan te geven, hiermee vergemakkelijken we de identificatie van welke onderdelen bij welke horen.
We moeten ook zorgen voor de ruimte tussen de verschillende elementen waaruit de verklaringen bestaan, aangezien misbruik een leesbaarheidsprobleem kan veroorzaken.
Laten we een voorbeeld van elk ding bekijken, bijvoorbeeld de ruimte tussen elementen, in de afbeelding zien we de juiste vorm in het onderste gedeelte, waar elk element wordt gescheiden door een spatie, maar in het bovenste gedeelte zien we op de verkeerde manier dat er is geen uniformiteit in de ruimtes.
Zoals we aan het begin vermeldden, documentatie stelt ons in staat om onze opmerkingen in de code aan te geven, hiervoor zullen we de schrijfhulpmiddelen gebruiken opmerkingen in Java; Als we bijvoorbeeld elke stap die we in de code uitvoeren willen documenteren, kunnen we // gebruiken om een regel te genereren die door de compiler wordt weggelaten, maar die uit het bronbestand kan worden gelezen.
Als we aan het begin van de les een commentaarblok maken met:
/** /* /* **/
Wat we in dat blok schrijven, kan worden geëxporteerd en gebruikt om HTML-documenten te genereren met de tools van: java-documentatie. Dus we moeten elk geval dienovereenkomstig gebruiken.
Aan het einde van de tutorial hebben we een breder begrip van de best practices bij het maken van Java-programma's om op functioneel niveau samen te werken met ontwikkeling, maar een beetje verder te gaan dan onze verantwoordelijkheden als een goede ontwikkelaar.Vond je deze Tutorial leuk en heb je eraan geholpen?Je kunt de auteur belonen door op deze knop te drukken om hem een positief punt te geven
