Dokumentationen skede av ett programmeringsspråk utvecklingsprocess innebär att skriva små anteckningar eller memos för att förklara en viss del av koden . Detta stadium kan antingen göras i slutet av utvecklingsprocessen, eller vid sidan av skapandet scenen .
Tillägg
En viktig del i dokumentationen steget är införandet av tillägg och rätt plats för sin kod i programmet . Att ge platshållare för framtida tillägg förenklar lokalisera platsen och placerar en påminnelse för en återgång till den punkten .
Buggar och fel
Dokumentationen ska också innehålla en förteckning över alla kända buggar och fel och de potentiella platser varifrån det kommer . Precis som dessutom listor , dessa fel och misstag listorna är programmerare med en påminnelse för nuvarande eller framtida arbete och en bättre uppfattning om var de buggar och fel skapas .
läsbarhet
En av de största faktorerna för dokumentation scenen i ett programs livscykel är läsbarhet i programplaneringen för nuvarande och framtida programmerare . Genom att lägga till anteckningar och promemorior vid sidan av programmering , kan en utvecklare skapa en bit efter bit, bruksanvisning och beskrivning av hur programmet fungerar . Detta kan öka produktiviteten om koden återanvänds vid ett senare tillfälle eller säljas till en sekundär företag för modifiering och integration .
コメント