Når du skriver kode til et program, er det nemt at rette alle fejlene og få det til at kompilere korrekt, men det gør det nemt for en anden person at læse det, det er meget sværere. Her er nogle tip, der kan hjælpe dig med at forbedre din læsbarhed.

Steps

  1. 1 Folk, der opretholder kode, er aldrig lige så velbevandrede som den oprindelige forfatter. De kan have dårligere programmeringsevner og vil vide mindre om projektet. Dette er den person, du skriver programmet til. Du vil have koden til at være nem for denne person.
  2. 2 Bare fordi en sprogfunktion er tilgængelig på et sprog, betyder det ikke, at du skal bruge det. Målet er at kommunikere, hvad koden gør til den næste læser, for ikke at imponere ham med, hvor få linjer du kan tage for at skrive kode.
  3. 3 Ofte er en algoritme vanskelig at følge. Men ofte offentliggøres det et eller andet sted. Placer URI for dokumentationen for algoritmen i kommentarafsnittet for koden. Hvis URI peger på et sted, der er flygtigt, skal du derefter kopiere oplysningerne et sted, hvor kodeholderen kan finde den.
  4. 4 Henvis til kodningsstandarden i filens overskrift. Giv en fil, hvis det er muligt, at værktøjerne kan åbne for at indarbejde de korrekte indstillinger. Som et eksempel bruges Eclipse til at bruge faner, men faner gengives forskelligt på forskellige tekstredigerere. Brug af hvidt mellemrum i stedet for faner kan være at foretrække, men at have en fil, der indeholder de korrekte indstillinger for et projekt.
  5. 5 Brug hvidt mellemrum. Spring over linjer mellem kode, der gør forskellige ting, og brug mellemrum efter semikolon og komma. Dette vil gøre din kode ser renere og lettere at læse.
  6. 6 Inders inde krøllede beslag. Dette gør det sådan, at det er indlysende, at en del kode er adskilt fra en anden. Dette kan hjælpe, når du skriver en lang metode. Indrykk indvendigt, hvis udsagn og løkker gør det nemt at læse. Denne teknik kaldes nesting, det viser, at et stykke kode er "indlejret" i et andet stykke kode, og giver læseren mulighed for nemt at følge nestemønsteret.
  7. 7 Skriv beskrivende kommentarer. Antag den person, der læser din kode, ved intet om, hvad den skal gøre. Dine kommentarer skal forklare ethvert trin i vejen. Alle af dine avancerede, forvirrende eller komplicerede algoritmer bør kommenteres godt. Prøv også at beskrive hvilket formål koden har. For eksempel, i stedet for at skrive "Tilføj en til variabel", siger hvorfor dette er vigtigt i koden, som alle kan se, at det øger variablen, for eksempel "forøg antallet af side hits med 1".
  8. 8 Lav din kode "selvdokumenterende" ved at oprette beskrivende objektnavne, der beskriver hvad deres formål er. Objekter bør enten referere til domænet for problemet eller standard software artefakter. En liste er en liste. Det kan være nødvendigt at oprette en kundeliste, hvilke underklasser eller implementerer en liste. Variabler og funktionsparametre skal have beskrivende navne.
  9. 9 Medtag den oprindelige forfatter og den nuværende indehaver af koden i den oprindelige kommentar i filen. Dette fortæller folk, hvem der skal gå for at betjene koden.
  10. 10 Kommenter ofte. Skriv kommentarer for at indikere din hensigt. Over at kommentere din kode vil føre til, at nogen sletter dine kommentarer.