Kodningsstandarder och konventioner för programmeringsspråk som Java är utformade för att förbättra kvaliteten och tillförlitligheten av applikationer byggda med dessa språk . Java-projekt är ofta stora , med varierande komponenter arbetat med ett antal olika utvecklare . Att ha en gemensam uppsättning metoder innebär att utvecklare kan arbeta med allas kod mer effektivt , eftersom koden är tydligare och lättare att läsa . Namnge
Java konventioner diktera vissa regler för namngivning programinslag som exempelvis variabler , klasser , objekt , paket och gränssnitt bland annat. CamelCase används i de flesta fall som i följande exempel :
//klassnamn börja versaler
Class
MyClass Twitter //variabler börjar gemener Object
anObject
i allmänhet använder meningsfulla namn , till exempel " disk " istället för " c " så att människor ( inklusive dig själv ) läser koden kan förstå det lättare .
indrag
Indragningen är en av de viktigaste delarna i programmering som gör koden lättare att läsa . Indrag bör generellt spegla de logiska strukturer i ett program , och hjälper till att identifiera information på ett ögonblick , till exempel omfattningen av variabler . Java konventioner föreskriver också där pauser bör ske inom inslagna rader kod , med de föredragna radbrytningar uppträder efter kommatecken och före operatörerna , enligt följande :
aMethod ( parameterOne , parameterTwo ,
parameterThree ) ;
int answer = itemOne + itemTwo
+ itemThree ; .
De andra linjerna i dessa fall bör helst komma efter åtta platser
kommentarer
användningen av kommentarer gör hela koden lättare att arbeta med , speciellt om långa eller komplexa algoritmer är inblandade . Kodkommentarer enligt Java- konventioner bör ingå innan deklarationer av viktiga variabler , metoder , klasser och några långa strukturer , liksom inuti alla dessa . Använd både singel -och multi - line kommentarer , som förekommer på sina egna linjer eller vid slutet av rader kod :
/*
* Detta är en kommentar i ett block
* /
//Detta är en enda rad kommentarer
int räknare = 0; //Detta är ytterligare information om kodrad Addera Dokumentation
Du skapar Java dokumentation främst genom att använda Javadoc anläggningen , som genererar HTML-dokument mest vanliga Java resurser och använd , inklusive själva språket . Du skapar Javadoc innehåll inom källkod med Javadoc kommentarer :
/**
* Detta är en Javadoc kommentar
* - notera dubbel asterisk börja
* /
När utvecklare arbetar med kod som utvecklats av någon annan , är deras första referenspunkt ofta Javadoc , eftersom det ger en överblick över resursen utan att faktiskt läsa själva koden . Addera Programkonstruktion
p Det finns många konventioner och standarder för genomförandet detaljer inom Java -program . Ett sådant exempel är den metod för att ge åtkomst till variabler i en klass från extern kod . ( Se referenser 4 ) Det är allmänt rekommenderas att hålla klassvariabler privat , och ger tillgång till dem med hjälp av offentliga metoder . Till exempel, om en klass har en text variabelsträngen instans som heter " someData " det kunde ha en metod som ger tillgång till den från någon annanstans i ansökan :
public string getData ( ) {return someData ; }
Addera ditt
