Tämä wikiHow opettaa sinulle, kuinka luoda pseudokoodiasiakirja tietokoneohjelmalle. Pseudokoodi sisältää olennaisesti ohjelmointikielisen ääriviivan luomisen koodisi tarkoituksesta.
Askeleet
Osa 1/3: Pseudokoodin perusteiden ymmärtäminen
Vaihe 1. Tiedä mikä on pseudokoodi
Pseudokoodi on vaiheittainen kirjoitettu hahmotelma koodistasi, jonka voit vähitellen kirjoittaa ohjelmointikielelle. Monet ohjelmoijat käyttävät sitä suunnitellakseen algoritmin toiminnan ennen kuin ryhtyvät teknisempään koodaustehtävään.
Pseudokoodi toimii epävirallisena oppaana, työkaluna ohjelmaongelmien pohtimiseen ja viestintävaihtoehdolla, joka voi auttaa sinua selittämään ideasi muille ihmisille.
Vaihe 2. Ymmärrä miksi pseudokoodi on hyödyllinen
Pseudokoodia käytetään osoittamaan, miten laskenta -algoritmin pitäisi toimia. Kooderit käyttävät usein pseudokoodia ohjelmoinnin välivaiheena alkusuunnitteluvaiheen ja varsinaisen suoritettavan koodin kirjoittamisvaiheen välillä. Jotkut muut pseudokoodin käyttötarkoitukset ovat seuraavat:
- Kuvataan kuinka algoritmin pitäisi toimia. Pseudokoodi voi havainnollistaa, missä tietty konstrukti, mekanismi tai tekniikka voi tai pitää esiintyä ohjelmassa.
- Tietojenkäsittelyprosessin selittäminen vähemmän teknisille käyttäjille. Tietokoneet tarvitsevat erittäin tiukan syöttösyntaksin ohjelman suorittamiseen, mutta ihmisten (erityisesti ei-ohjelmoijien) voi olla helpompi ymmärtää sujuvampaa, subjektiivista kieltä, joka ilmoittaa selvästi kunkin koodirivin tarkoituksen.
- Koodin suunnittelu ryhmäasetuksissa. Korkean tason ohjelmistoarkkitehdit sisällyttävät usein malleihinsa pseudokoodin, joka auttaa ratkaisemaan monimutkaisen ongelman, jonka ohjelmoijat kohtaavat. Jos kehität ohjelmaa yhdessä muiden kooderien kanssa, saatat huomata, että pseudokoodi auttaa tekemään aikomuksesi selväksi.
Vaihe 3. Muista, että pseudokoodi on subjektiivinen ja ei -standardi
Ei ole olemassa syntaksia, jota sinun on ehdottomasti käytettävä pseudokoodia varten, mutta tavallista ammattimaista kohteliaisuutta on käyttää tavallisia pseudokoodirakenteita, jotka muut ohjelmoijat voivat helposti ymmärtää. Jos koodaat projektia itse, tärkeintä on, että pseudokoodi auttaa sinua jäsentämään ajatuksesi ja toteuttamaan suunnitelmasi.
- Jos työskentelet muiden kanssa projektissa-olivatpa he sitten vertaisiasi, nuorempia ohjelmoijia tai ei-teknisiä yhteistyökumppaneita-on tärkeää käyttää ainakin joitain vakiorakenteita, jotta kaikki muut voivat helposti ymmärtää tarkoituksesi.
- Jos olet ilmoittautunut ohjelmointikurssille yliopistossa, koodausleirillä tai yrityksessä, sinut testataan todennäköisesti opetetun pseudokoodin "standardin" mukaan. Tämä standardi vaihtelee usein oppilaitosten ja oppilaitosten välillä.
Selkeys on pseudokoodin ensisijainen tavoite, ja se voi auttaa, jos työskentelet hyväksyttyjen ohjelmointikäytäntöjen mukaisesti. Kun kehität pseudokoodiasi todelliseksi koodiksi, sinun on transkriboitava se ohjelmointikielelle - joten se voi auttaa jäsentämään ääriviivat tämän mielessä.
Vaihe 4. Keskity pseudokoodin päätarkoitukseen
Koodin kirjoittaminen voi olla helppoa, kun saavutat askeleesi. Kun muistat pseudokoodisi tarkoituksen ja selität, mitä kunkin ohjelman rivin pitäisi tehdä, pidät sinut maadoitettuna pseudokoodiasiakirjan luomisessa.
Osa 2/3: Hyvän pseudokoodin kirjoittaminen
Vaihe 1. Käytä pelkkää tekstieditoria
Saattaa olla houkuttelevaa käyttää tekstinkäsittelyohjelmaa (esim. Microsoft Word) tai vastaavaa ohjelmaa rikkaan tekstin asiakirjan luomiseen, mutta pseudokoodi tarvitsee mahdollisimman vähän muotoilua, jotta se olisi yksinkertainen.
Tavallisia tekstieditoria ovat Notepad (Windows) ja TextEdit (Mac).
Vaihe 2. Aloita kirjoittamalla muistiin prosessin tarkoitus
Rivin tai kahden omistaminen koodin tarkoituksen selittämiseen auttaa määrittämään loput asiakirjasta ja säästää myös tehtävän selittää ohjelman toiminta jokaiselle henkilölle, jolle näytät pseudokoodin.
Vaihe 3. Kirjoita vain yksi lauseke riviä kohden
Jokaisen pseudokoodisi lausunnon tulisi ilmaista vain yksi toiminto tietokoneelle. Useimmissa tapauksissa, jos tehtäväluettelo on piirretty oikein, jokainen tehtävä vastaa yhtä pseudokoodiriviä. Harkitse tehtäväluettelon kirjoittamista, sen jälkeen luettelon kääntämistä pseudokoodiksi ja sitten sen kehittämistä vähitellen todelliseksi, tietokoneella luettavaksi koodiksi.
Vaihe 4. Käytä tyhjää tilaa ja sisennystä tehokkaasti
Tekstin "lohkojen" välissä olevien välilyönnien käyttäminen auttaa pitämään pseudokoodisi eri komponentit erillään, ja kunkin lohkon eri osien sisennys osoittaa, että nämä pseudokoodin palat menevät vähemmän sisennettyyn osaan.
Esimerkiksi pseudokoodiosan, joka käsittelee numeron syöttämistä, pitäisi kaikkien olla samassa "lohkossa", kun taas seuraavan osion (esim. Osio, joka käsittelee lähtöä) pitäisi olla eri lohkossa
Vaihe 5. Käytä isoja näppäinkomentoja tarvittaessa
Riippuen pseudokoodivaatimuksistasi tai ympäristöstä, jossa julkaiset pseudokoodin, sinun on ehkä kirjoitettava isolla kirjaimella todelliseen koodiin jäävät komennot.
Jos käytät esimerkiksi "if" - ja "then" -komentoja pseudokoodissasi, haluat ehkä muuttaa ne lukemiksi "IF" ja "THEN" (esim. "IF input number THEN output output")
Vaihe 6. Kirjoita yksinkertaisella terminologialla
Muista, että kirjoitat siitä, mitä projekti tekee, et tiivistä itse koodia. Tämä on erityisen tärkeää, jos kirjoitat pseudokoodia esittelyksi asiakkaalle, joka ei tiedä koodausta, tai projektiksi aloittelevalle ohjelmoijalle.
Haluat ehkä jopa päästä eroon kaikista koodauskomennoista kokonaan ja määrittää vain kunkin rivin prosessin selkeällä kielellä. Esimerkiksi "jos syöte on pariton, tulostuksesta" Y "" voi tulla ", jos käyttäjä syöttää parittoman numeron, näytä sen sijaan" Y "".
Vaihe 7. Pidä pseudokoodisi oikeassa järjestyksessä
Vaikka kielen, jota käytät pseudokoodin muokkaamiseen, pitäisi olla yksinkertainen, sinun on silti pidettävä jokainen osa pseudokoodistasi siinä järjestyksessä, jossa se on suoritettava.
Vaihe 8. Älä jätä mitään mielikuvituksen varaan
Kaikki prosessissa tapahtuva on kuvattava kokonaan. Pseudokoodilausekkeet ovat lähellä yksinkertaisia englanninkielisiä lausuntoja. Pseudokoodi ei tyypillisesti käytä muuttujia, vaan kuvaa sen sijaan, mitä ohjelman pitäisi tehdä todellista maailmaa lähellä olevien objektien, kuten tilinumeroiden, nimien tai tapahtumasummien, kanssa.
Vaihe 9. Käytä vakio -ohjelmointirakenteita
Vaikka pseudokoodille ei ole standardia, muiden ohjelmoijien on helpompi ymmärtää vaiheesi, jos käytät olemassa olevien (peräkkäisten) ohjelmointikielien rakenteita. Käytä termejä "if", "then", "while", "else" ja "loop" samalla tavalla kuin käyttäisit haluamaasi ohjelmointikieltä. Harkitse seuraavia rakenteita:
- jos KUNTO, niin OHJE - Tämä tarkoittaa, että annettu ohje suoritetaan vain, jos tietty ehto on totta. "Ohje" tarkoittaa tässä tapauksessa askelta, jonka ohjelma suorittaa, kun taas "ehto" tarkoittaa, että tietojen on täytettävä tietyt kriteerit ennen kuin ohjelma ryhtyy toimiin.
- kun CONDITION suorittaa OHJEET - Tämä tarkoittaa, että käsky on toistettava yhä uudelleen, kunnes ehto ei enää ole totta.
- tee OHJE kun KUNTO - Tämä on hyvin samanlainen kuin "kun kunto suorittaa OHJE". Ensimmäisessä tapauksessa ehto tarkistetaan ennen opetuksen suorittamista, mutta toisessa tapauksessa opetus suoritetaan ensin; toisessa tapauksessa OHJE suoritetaan vähintään kerran.
- toiminto NAME (ARGUMENTIT): OHJE - Tämä tarkoittaa, että joka kerta, kun koodissa käytetään tiettyä nimeä, se on lyhenne tietystä ohjeesta. "Argumentit" ovat muuttujien luetteloita, joiden avulla voit selventää ohjeita.
Vaihe 10. Järjestä pseudokoodiosat
Jos sinulla on suuria pseudokoodiosia, jotka määrittävät muita pseudokoodin osia samassa lohkossa, voit halutessasi käyttää hakasulkeita tai muita tunnisteita kaiken sisällön säilyttämiseen.
- Hakasulkeet-sekä vakio (esim. [Koodi]) että kaarevat (esim. {Koodi})-voivat auttaa sisältämään pitkiä pseudokoodisegmenttejä.
-
Koodauksen aikana voit lisätä kommentteja kirjoittamalla kommentin vasemmalle puolelle "" (esim.
// Tämä on väliaikainen askel.
- ). Voit käyttää samaa menetelmää kirjoittaessasi pseudokoodia jättääksesi muistiinpanoja, jotka eivät sovi koodaustekstiin.
Vaihe 11. Tarkista pseudokoodisi luettavuus ja selkeys
Sinun pitäisi pystyä vastaamaan seuraaviin kysymyksiin asiakirjan loppuun mennessä:
- Ymmärtäisikö tämä pseudokoodi joku, joka ei tunne prosessia?
- Onko pseudokoodi kirjoitettu siten, että se on helppo kääntää tietokoneen kielelle?
- Kuvaako pseudokoodi koko prosessia jättämättä mitään pois?
- Onko kohdeyleisö selvästi ymmärtänyt jokaisen pseudokoodissa käytetyn objektin nimen?
- Jos huomaat, että osa pseudokoodista vaatii tarkennusta tai siinä ei nimenomaisesti hahmotella vaihetta, jonka joku muu saattaa unohtaa, palaa takaisin ja lisää tarvittavat tiedot.
Osa 3/3: Esimerkkipseudokoodiasiakirjan luominen
Vaihe 1. Avaa pelkkä tekstieditori
Voit käyttää Notepadia (Windows) tai TextEdit (Mac) oletuksena, jos et halua asentaa uutta ohjelmaa.
Vaihe 2. Määritä ohjelma
Vaikka se ei ole ehdottoman välttämätöntä, yhden tai kahden lauseen rivin kirjoittaminen asiakirjan yläosaan tekee alusta alkaen selväksi ohjelman tarkoituksen:
Tämä ohjelma pyytää tervehdystä käyttäjältä. Jos tervehdys vastaa tiettyä vastausta, vastaus toimitetaan; jos ei, hylkäys annetaan.
Vaihe 3. Kirjoita avausjärjestys
Ensimmäinen komento-eli ensimmäinen asia, jonka ohjelmasi pitäisi tehdä suoritettaessa-tulisi olla ensimmäinen rivi:
tulosta tervehdys "Hei muukalainen!"
Vaihe 4. Lisää seuraava rivi
Aseta väli viimeisen ja seuraavan rivin väliin painamalla ↵ Enter ja luo sitten seuraava koodirivi. Tässä esimerkissä käyttäjän tulee pyytää seuraavaa vuoropuhelua:
Tulosta kehote painamalla "Enter" jatkaaksesi
Vaihe 5. Lisää toimintakehotus
Tässä esimerkissä käyttäjää pyydetään tervehtimään:
tulosta toimintakehotus "Miten voit?"
Vaihe 6. Näytä käyttäjälle vastausluettelo
Jälleen kerran, kun olet painanut example Enter tässä esimerkissä, käyttäjän pitäisi nähdä luettelo mahdollisista vastauksista:
näytä mahdolliset vastaukset "1. Hieno." "2. Hienoa!" "3. Ei hyvä."
Vaihe 7. Pyydä syötettä käyttäjältä
Tässä ohjelma pyytää käyttäjää syöttämään vastauksen:
tulostuspyyntö syöttöön "Anna numero, joka kuvaa sinua parhaiten:"
Vaihe 8. Luo "if" -komennot käyttäjän syötteelle
Koska käyttäjä voi valita useita vastauksia, sinun kannattaa lisätä useita tuloksia valitun vastauksen perusteella:
jos "1" tulostusvastaus "Dandy!" jos "2" tulostusvastaus "Fantastic!" jos "3" tulostusvastaus "Vaalenna, leinikki!"
Vaihe 9. Lisää virheilmoitus
Jos käyttäjä valitsee vastauksen väärin, voit saada virhesanoman valmiiksi:
jos tuloa ei tunnisteta tulostusvastausta "Etkö noudata ohjeita kovin hyvin?"
Vaihe 10. Lisää muut ohjelman osat
Käy läpi asiakirja ja lisää tai tarkenna kaikki tiedot varmistaaksesi, että sekä sinä että kuka tahansa asiakirjan lukija ymmärtävät sen merkityksen. Tämän menetelmän esimerkin mukaan lopullisen pseudokoodiasiakirjan pitäisi näyttää tältä:
Tämä ohjelma pyytää tervehdystä käyttäjältä. Jos tervehdys vastaa tiettyä vastausta, vastaus toimitetaan; jos ei, hylkäys annetaan. tulosta tervehdys "Hei muukalainen!" Tulosta kehote painamalla "Enter" jatkaaksesi
tulosta toimintakehotus "Miten voit tänään?" näytä mahdolliset vastaukset "1. Hieno." "2. Hienoa!" "3. Ei hyvä." tulostuspyyntö syöttöä varten "Anna numero, joka kuvaa sinua parhaiten:" jos "1" tulostusvastaus "Dandy!" jos "2" tulostusvastaus "Fantastic!" jos "3" tulostusvastaus "Vaalenna, leinikki!" jos tuloa ei tunnisteta tulostusvastausta "Etkö noudata ohjeita kovin hyvin?"
Vaihe 11. Tallenna asiakirja
Paina Ctrl+S (Windows) tai ⌘ Command+S (Mac), kirjoita nimi ja napsauta Tallentaa tehdä niin.
