koding standarder og konvensjoner for programmeringsspråk som Java er utformet for å forbedre kvaliteten og påliteligheten til applikasjoner bygget ved hjelp av disse språkene. Java-prosjekter er ofte store , med varierende komponenter jobbet på av en rekke forskjellige utviklere . Å ha et felles sett av praksis betyr at utviklere kan jobbe med alles kode mer effektivt , som koden er klarere og lettere å lese. Naming
Java konvensjoner diktere visse regler for navngiving program elementer som variabler , klasser , objekter , pakker og grensesnitt blant andre. CamelCase brukes i de fleste tilfeller som i følgende eksempler : en
//klasse navn starter med store bokstaver
Class MyClass
//variabler starte små
Object anObject
generelt bruke meningsfulle navn , for eksempel " teller " i stedet for "c ", slik at folk ( inkludert deg selv ) å lese koden din kan forstå det lettere.
innrykk
Skår er en av de viktigste elementene i programmering som gjør koden lettere å lese. Innrykk bør generelt gjenspeile de logiske strukturer i et program , og bidrar til å identifisere informasjon på et øyeblikk , for eksempel omfanget av variabler . Java- konvensjonene også diktere hvor bør oppstå innenfor linjer med kode , med de foretrukne linjeskift oppstår etter komma og før operatører , som følger :
aMethod ( parameterOne , parameterTwo , etter
parameterThree );
int svar = itemOne + itemTwo
+ itemThree ; .
andre linjer i disse tilfellene bør ideelt sett komme etter åtte plasser
Kommentarer
bruken av kommentarer gjør hele koden lettere å jobbe med, spesielt hvis lange eller kompliserte algoritmer er involvert . Koden kommentarer henhold til Java- konvensjoner skal inkluderes før erklæringer av viktige variabler , metoder , klasser og eventuelle lange strukturer, så vel som inne alle disse. Bruk begge single og multi-line kommentarer , som oppstår på egne linjer eller i slutten av kodelinjer :
/*
* Dette er en kommentar i en blokk
* /
//Dette er en enkelt linje kommentar
int teller = 0; //Dette er tilleggsinformasjon om kodelinje
Dokumentasjon
Du oppretter Java dokumentasjon først og fremst ved hjelp av Javadoc anlegget, som genererer HTML-dokumenter mest vanlige Java- ressurser og programmer bruker , inkludert selve språket . Du oppretter Javadoc innholdet i kildekoden ved hjelp av javadoc kommentarer :
/**
* Dette er en Javadoc kommentar
* - merk den doble asterisk å begynne
< p> * /
Når utviklere jobber med kode som ble utviklet av noen andre, er deres første referansepunkt ofte Javadoc , da det gir en oversikt over ressurs uten å faktisk lese selve koden .
Program Design
p Det er mange konvensjoner og standarder for gjennomføring detaljer innenfor Java-programmer . Ett slikt eksempel er tilnærmingen til å gi tilgang til variablene i en klasse fra ekstern kode . (Se Referanser 4 ) Det er generelt anbefalt å holde klassevariabler private, og gi tilgang til dem ved hjelp av offentlige metoder. For eksempel, hvis en klasse har en tekststreng instansvariabel heter " someData " det kunne ha en metode som gir tilgang til den fra et annet sted i programmet : en
public string GetData ( ) {return someData ; }