Wku

Hur kan man förbättra läsbarheten av din programkod

När du skriver kod för ett program, är det lätt att fixa alla buggar och har det kompilera korrekt, men gör det lätt för en annan människa att läsa det är mycket svårare. Här är några tips som hjälper dig att förbättra din kodens läsbarhet.

Steg

Hur kan man förbättra läsbarheten av din programkod. Människor som upprätthåller kod är aldrig så väl bevandrade i den ursprungliga författaren.
Hur kan man förbättra läsbarheten av din programkod. Människor som upprätthåller kod är aldrig så väl bevandrade i den ursprungliga författaren.
  1. 1
    Människor som upprätthåller kod är aldrig så väl bevandrade i den ursprungliga författaren. De kan ha sämre kunskaper i programmering och vet mindre om projektet. Detta är den person som du skriver programmet. Du vill att koden ska vara lätt för denna person.
  2. 2
    Bara för att ett språk funktionen finns i ett språk, betyder inte att du ska använda den. Målet är att kommunicera vad koden gör till nästa läsaren, att inte imponera på honom med hur några rader du kan vidta för att skriva kod.
  3. 3
    Ofta en algoritm är svår att följa. Men ofta är det publicerat någonstans. Placera URI av dokumentationen för algoritmen i kommentaren för koden. Om URI pekar på en plats som är flyktigt, sedan kopiera informationen någonstans där koden underhållare kan hitta det.
  4. 4
    Hänvisning den kodande standard i sidhuvudet i filen. Ge en fil om möjligt att verktyg kan öppna för att införliva de rätta inställningarna. Som ett exempel Eclipse standard med flikar, men flikar återges olika på olika textredigerare. Använda blanktecken istället för flikar kan vara att föredra, men med en fil som ger rätt inställningar för ett projekt.
  5. 5
    Använd blanktecken. Hoppa linjer mellan kod som gör olika saker, och använda mellanslag efter semikolon och kommatecken. Detta kommer att göra din kod ser renare och lättare att läsa.
  6. 6
    Indrag inuti klammerparenteser. Detta gör det så att det är uppenbart att en bit av koden är skild från en annan. Detta kan hjälpa när man skriver ett långt förfarande. Indrag insidan om uttalanden och loopar gör det lätt att läsa. Denna teknik kallas kapsling, är att den visar en bit av koden är "kapslad" inom en annan bit av koden, och tillåter läsaren att enkelt följa häckande mönster.
  7. 7
    Skriv beskrivande kommentarer. Antag att personen läser din kod vet ingenting om vad den ska göra. Dina synpunkter bör förklara varje steg på vägen. Alla dina avancerade, förvirrande eller komplicerade algoritmer väl bör kommenteras. Försök också att beskriva vad syftet med koden har. Till exempel, istället för att skriva "lägg till en till variabel," säga varför det är viktigt i koden, eftersom vem som helst kan se den uppräkning av variabel, t.ex. "ökning av antalet sidträffar med 1".
  8. 8
    Gör din kod "självdokumenterande" genom att skapa beskrivande objektnamn som beskriver vad deras syften är. Objekt bör antingen referera till domänen av problemet eller vanliga artefakter programvara. En lista är en lista. Du kan behöva att skapa en kundlista som underklasser eller implementerar en lista. Variabler och parametrar funktionen ska ha beskrivande namn.
  9. 9
    Inkludera den ursprungliga författaren och den nuvarande ansvarige för koden i den inledande kommentaren av filen. Detta berättar för folk som att gå till för att serva koden.
  10. 10
    Kommentar ofta. Skriv kommentarer att visa din avsikt. Över kommentera din kod kommer att leda till någon radera dina kommentarer.

Tips

  • Lägg vita utrymmen om de tillåts.
  • Om du vill kommentera en stor bit av text, använd "/ *" för att starta kommentaren och "* /" för att avsluta det. Då behöver du inte skriva "/ /" på varje rad. (Notera att göra kommentarer kan vara annorlunda på andra språk)
  • Göra din kod lättare att läsa kommer också att hjälpa dig att felsöka ditt eget program, vilket gör det lättare för dig själv.
  • Konstant variabler bör skrivas med stora bokstäver, med ord separerade med ett understreck. Regelbundna variabler bör ha de första bokstäverna i varje ord aktiveras, utelämna understreck.
  • Hitta din stil att skriva kod. Det finns en mängd olika stilar som du kan använda, till exempel följande exempel: myVariable, MyVariable, myVariable, MINVARIABEL, My_Variable, MY_VARIABLE, my_variable, my_Variable, My_variable, och mer. Se till att du tilldelar varje stil till en specifik typ som MY_VARIABLE för konstanta variabler och myVariable för vanliga variabler. Bara se till att du stannar konsekvent genom stil. Du vill inte sluta med både myVariable och MY_VARIABLE konstanta variabler.