Wku

Hvordan forbedre lesbarheten av programvaren koden

Når du skriver kode for et program, er det lett å fikse alle feilene og kompilere den har riktig, men gjør det enkelt for et annet menneske å lese det er mye vanskeligere. Her er noen tips som vil hjelpe deg med å forbedre koden lesbarheten.

Trinn

Hvordan forbedre lesbarheten av programvaren koden. Folk som opprettholder kode er aldri så godt bevandret som den opprinnelige forfatteren.
Hvordan forbedre lesbarheten av programvaren koden. Folk som opprettholder kode er aldri så godt bevandret som den opprinnelige forfatteren.
  1. 1
    Folk som opprettholder kode er aldri så godt bevandret som den opprinnelige forfatteren. De kan ha dårligere kunnskaper om programmering og vil vite mindre om prosjektet. Dette er den personen du skriver programmet for. Du vil koden bli lett for denne personen.
  2. 2
    Bare fordi et språk funksjonen er tilgjengelig i et språk, betyr ikke at du bør bruke den. Målet er å kommunisere hva koden gjør til neste leseren, ikke for å imponere ham med hvor få linjer du kan ta for å skrive kode.
  3. 3
    Ofte er en algoritme er vanskelig å følge. Men ofte er det publisert et sted. Plasser URI av dokumentasjonen for algoritmen i kommentarfeltet for koden. Hvis URI peker til et sted som er flyktig, deretter kopiere informasjonen sted hvor koden vedlikeholder kan finne den.
  4. 4
    Referere til koding standard i overskriften av filen. Gi en fil hvis det er mulig at verktøy kan åpne for å innlemme de riktige innstillingene. Som et eksempel Eclipse standard til å bruke faner, men faner gjengis forskjellig på forskjellige tekstbehandlingsprogrammer. Ved hjelp av mellomrom i stedet for faner kan være å foretrekke, men å ha en fil som gir de riktige innstillingene for et prosjekt.
  5. 5
    Bruk mellomrom. Hopp linjer mellom kode som gjør forskjellige ting, og bruke mellomrom etter semikolon og komma. Dette vil gjøre koden ser renere og enklere å lese.
  6. 6
    Innrykk inne klammeparentes. Dette gjør det slik at det er åpenbart at en del av koden er atskilt fra hverandre. Dette kan hjelpe når du skriver en lang metode. Innrykk inne hvis uttalelser og looper vil gjøre det lett å lese. Denne teknikken kalles hekkende, er at den viser en del av koden er "nestes" i en annen del av koden, og lar leseren enkelt kan følge hekkende mønsteret.
  7. 7
    Skriv beskrivende kommentarer. Anta at personen lese koden din vet ingenting om hva det er ment å gjøre. Dine kommentarer bør forklare hvert steg på veien. Alle dine avanserte, forvirrende, eller kompliserte algoritmer bør være godt kommentert. Også prøve å beskrive hva formålet koden har. For eksempel, i stedet for å skrive "legge en til variabel," sier hvorfor dette er viktig i koden, som alle kan se det er inkrementering variabelen, for eksempel "økning av antall sidevisninger med 1".
  8. 8
    Gjøre koden "selv dokumentere" ved å lage beskrivende objekt navn som beskriver hva deres formål er. Gjenstander bør enten referere domenet av problemet eller standard programvare gjenstander. En liste er en liste. Du må kanskje lage en kundeliste som underklasser eller implementerer en liste. Variabler og funksjonsparametere bør ha beskrivende navn.
  9. 9
    Inkludere den opprinnelige forfatteren og nåværende vedlikeholder av koden i første kommentaren av filen. Dette forteller folk hvem du skal gå til å betjene koden.
  10. 10
    Kommentar ofte. Skriv kommentarer å indikere din hensikt. Over kommenterer koden din vil føre til noen slette dine kommentarer.

Tips

  • Legg mellomrom hvis de får lov.
  • Hvis du ønsker å kommentere en stor del av teksten, bruk "/ *" for å starte kommentar og "* /" for å avslutte det. Deretter trenger du ikke å skrive "/ /" på hver linje. (Merk at det å gjøre kommentarene kan være annerledes på andre språk)
  • Å gjøre en koden lettere å lese vil også hjelpe deg å feilsøke ditt eget program, noe som gjør det lettere for deg selv.
  • Konstant variabler bør være i alle caps, med ord atskilt med en understrek. Vanlige variabler bør ha de første bokstavene i hvert ord bli kapitalisert, utelate understrek.
  • Finn din stil å skrive kode. Det finnes en rekke ulike stiler du kan bruke, for eksempel følgende eksempler: myVariable, myVariable, myVariable, myVariable, My_Variable, MY_VARIABLE, my_variable, my_Variable, My_variable og mer. Sørg for at du tilordne hver stil til en bestemt type som MY_VARIABLE for konstant variabler og myVariable for vanlige variabler. Bare sørg for at du holder deg konsekvent gjennom stil. Du ønsker ikke å ende opp med å ha både myVariable og MY_VARIABLE konstant variabler.