Dator > hur dokumentet programkod för utbildnings- och utvecklingsprojekt

  • hur dokumentet programkod för utbildnings- och utvecklingsprojekt


  • Vid utveckling av nya programkoden , är behovet av extern granskning av antingen gruppmedlemmar eller pedagogiska väghyvlar viktigt . Medan många fokus på programvara dokumentation i form av användarhandböcker , skriver i en blygsam mängd dokumentation inom koden kan avsevärt påskynda felsökning och framtida utveckling. Vad är det bästa sättet att dokumentera programkod för utbildnings -och utvecklingsprojekt

    Du behöver :
    en fullständig beskrivning av koden avsikt och logik


    1
    <. br > Skriv in ditt namn eller lagets namn , den fullständiga definitionen av projektet eller uppdraget , och datum för kodens nuvarande iteration . Att veta vad koden skapades för kan hjälpa senare recensenter identifiera dem som skapade den, om du vill fixa det eller förbättrar den .
    2 .
    Lista logiken avsedda för varje nummer avsnitt innan det avsnitt börjar . Förklara både den avsedda funktionen och den logiska metod som används för att genomföra det . Sedan , om koden logiken är befunnits vara felaktiga , är det klart om metoden är att ändra eller beräkningarna .
    3 .
    Om en matematisk funktion eller transformation används , inkludera i texten linjer ovanför en komplett lista med funktionen att göra . Detta innebär att att om beräkningen ger felaktigt resultat kan man utläsa huruvida fel funktionen används eller om funktionen i koden är inte en match till det avsedda matematisk funktion . Detta gör det också lättare att uppdatera programmet till en ny matematisk funktion vid ett senare tillfälle .
    4 .
    Inkludera i kommentarerna programvaran språket och versionen som används för att skapa koden . Till exempel är det C, C + eller C + +? Vilken version av FORTRAN eller UNIX användes ? Att veta koden versionen kan förhindra inkompatibla program kompilatorer från att användas .

    tips och varningar


  • Om en kompilator används som är oförenligt med datorn språk som är skriven i , kommer att fel uppstår i den resulterande programmet . Om kompilatorn är endast avsedd för en senare version av programvaran språk än det programmet är skrivet i , kommer buggar och fel resultat också .
  • Om du kompilera koden själv , ta med i din programvara FAQ använt kompilatorn , utöver den ursprungliga programvaran språket . Detta gör felsökning av om problemet är den ursprungliga koden eller kompilator som används .

Previous:Vilka är fördelarna med Java uppgradera ? Next:hur man gör ett spel med hjälp av Java-programvara





Relaterade artiklar


  • inspiron 9200 specs
  • Canon LiDE 90 scanner specifikationer
  • hur man överklockar en AMD Sempron 3300
  • hp d530 specifikationer
  • Hur man använder en Logitech Chillstream Controller
  • hur man överklockar en G4-processor
  • hur du lägger till fler gigabyte till min dator
  • vad är T2400 processor?
  • hur man använder USB-enheter för extra minne på bärbara datorer
  • hur man driver en färg test sida på min bläckstråleskrivare HP 1200 skrivare