Dagens tema: Koding. Høynivåprogrammering, kommentarer og stil Kompilering av store programsystemer Prosjekter, samarbeide og versjoner

Transkript

1 Dagens tema Dagens tema: Koding Høynivåprogrammering, kommentarer og stil Kompilering av store programsystemer Prosjekter, samarbeide og versjoner

2 Hvorfor er stil viktig? Programmering i høynivåspråk Når man programmerer, skriver man mer for mennesker enn for datamaskiner! Hvordan skal man gjøre det lett for andre å forstå strukturen i programmet? Hvordan skal man gjøre det enklere for andre å skjønne programmererens tankegang?

3 Navn Navn Regler for hvordan navn skrives kan gi økt forståelse. Her er Javas fornuftige standardforslag: Klasser String, MainResponsible Metoder insert, getnext Variable i, elemcounter Konstanter MAXELEMS, FILELIMIT (et verb) (et substantiv)

4 Navn Lange eller korte navn? Mitt forslag: Lange navn i global sammenheng Korte navn i lokal sammenheng class ListingResponsible for (int i = 1; i <= 10; ++i)

5 Navn Unngå svært like navn antallfilersomerhalvtoppdatert antallfilersomerheltoppdatert

6 Valg av språk Engelsk eller norsk? Valgfritt, men vær konsekvent. Hvem vil lese programmet?

7 Kommentarer Dokumentasjon av programkoden Alle programmeringsspråk har muligheten for å legge inn kommentarer i programkoden. Uten slik dokumentasjon er det ofte vanskelig å forstå ideene bak programmet. void bubble(int a[], int n) { int i, temp, n_swaps; } do { n_swaps = 0; for (i=0; i<n 1; ++i) if (a[i]>a[i+1]) { temp = a[i]; a[i] = a[i+1]; a[i+1] = temp; ++n_swaps; } } while (n_swaps > 0);

8 Kommentarer Overkommentert? /* Sort array a with n elements using the technique called bubble sort. */ void bubble(int a[], int n) { /* Variables: i: loop index temp: temporary variable used during swapping n_swaps: count the number of swaps done */ int i, temp, n_swaps; /* Loop until no swaps were performed, as this implies that the array is completely sorted. */ do { /* Initialize the variables used in the loop. */ n_swaps = 0; for (i=0; i<n 1; ++i) /* In a bubble sort, all adjacent array elements are compared. If they are out of order, they are swapped*/ if (a[i]>a[i+1]) { /* Swapping uses a temporary variable. */ temp = a[i]; a[i] = a[i+1]; a[i+1] = temp; /* Remember to update the swap counter. */ ++n_swaps; } } while (n_swaps > 0); /* The array should now be completely sorted. */ }

9 Kommentarer Unngå å gjenta koden Fortell leseren noe han eller hun ikke vet. a = 2; // Variabelen a gis verdien 2. symbolgenerator.readsymbol(); // Les neste symbol.

10 Kommentarer Bruk få og lange kommentarer. Forklar sammenhengen grundig på et naturlig sted i koden, for eksempel i starten av en klasse eller metode. Bruk invarianter Slike betingelser forklarer mye på liten plass. De kan være mer eller mindre formelle. // s.length() > 4. // Variabelen lastread vil alltid inneholde // det siste tegnet som _ikke_ er satt inn i et symbol.

11 Kommentarer Grafiske muligheter i kommentarer Kommentarer kan også brukes til å gi visuell informasjon om de store linjene i programmet. /******************************************* ******* Klassen MainResponsible ******* *******************************************/ /********** Metoden printit **********/ // Noen nyttige metoder //

12 Oppsummering Konklusjon om koding Noen ganger er man pålagt standarder Eksempel: GNU prosjektet // Ellers må man utvikle sin egen stil: Tenk gjennom problemet. Les andres programmer. Les egne gamle programmer. Eksperimenter!

13 Hvordan kompilere riktig? Programmet make Det er mange praktiske problemer forbundet med programmering av et større program: Hvordan holde orden på et stort program når det er mange separatkompilerte filer? Hvis én fil endres, hvilke filer må da kompileres på nytt? Hvordan sikre at alle de riktige opsjonene er med ved hver kompilering? Hvordan unngå at brukeren skriver seg i hjel på lange kommandolinjer? Løsningen er make!

14 pmakefile en Brukeren lager en fil med navn makefile eller Makefile. Den ser slik ut: F 0 : F 1 F 2... F n Tab Kommandolinje Tab Kommandolinje. Dette betyr: 1. FilenF 0 er «avhengig» av filenef 1,F 2,...,F n. Det betyr at hvisf 0 er eldre enn noen av disse, måf 0 regenereres. 2. Kommandolinjene må da utføres for å genereref 0. Disse linjene må starte med en Tab.

15 Bruk av make Programmet make gjør altså følgende: 1. Først leses filen makefile eller Makefile. 2. Så bygger make opp en oversikt (nærmere bestemt en graf) over hvilke filer som avhenger av hvilke. Utgangspunktet (roten) for denne grafen oppgis som parameter til make; ellers tas første fil. Denne grafen angir hvilken rekkefølge filene skal sjekkes (og eventuelt regenereres) i. For Java programmer spiller ikke dette noen rolle, men av og til er dette vesentlig.

16 Bruk av make Nå kan hver fil sjekkes i riktig rekkefølge. Hvis 1. filen ikke finnes, eller 2. noen av filene den er avhengig av ikke finnes, eller 3. filen er eldre enn noen av de den er avhengig av, blir den regenerert. Brukeren får beskjed om hvilke kommandoer som utføres.

17 Bruk av make Et eksempel Denne bruker jeg for å kompilere Minila kompilatoren: Minila.jar: Minila.class manifest.txt jar cmf manifest.txt Minila.jar *.class Minila.class: Minila.java javac Minila.java clean: rm f *.class

18 Bruk av make make operasjoner Det fine med make er at man også kan legge inn handlinger (som «make clean» på forrige ark). > make clean rm f *.class

19 Bruk av make Forkortelser Det er mulig å definere forkortelser (makroer uten parametre): CC = cc CFLAGS = O DATARI_ST DIFI BIN = func.o prog.o prog: $(BIN) $(CC) $(CFLAGS) $(BIN) o prog prog.o: prog.c incl.h $(CC) $(CFLAGS) c prog.c func.o: func.c incl.h $(CC) $(CFLAGS) c func.c

20 Oppsummering Oppsummering om make make er meget nyttig til å holde orden på programsystemer med flere filer. Det dokumenterer hva som må gjøres. Et Unix system har tusener av Makefile er.

21 Samarbeidsproblemer Når flere samarbeider Når flere jobber sammen, kan man tråkke i beina på hverandre: 1. Per tar en kopi av en kildefil og begynner å rette på den. 2. Kari gjør det samme. 3. Kari blir første ferdig og kopierer filen tilbake. 4. Per blir ferdig og kopierer filen tilbake. Karis endringer går tapt.

22 Versjonskontrollsystemer Løsningen Et versjonskontrollsystem er løsningen. De fleste slike systemer er utsjekkingssystemer basert på låsing: 1. Per ber om og sjekker ut (dvs får en kopi av) filen og begynner å rette på den. 2. Kari ber om en kopi, men får den ikke fordi den er låst. Først når Per er ferdig og sjekker inn filen, kan Kari få sin kopi.

23 Versjonskontrollsystemer Fordeler med et slikt utsjekkingssystem: Ganske sikkert. (Men hva om Per og Kari begge må rette i to filer? Da kan de starte med hver sin fil, men når de er ferdige med den første filen kan systemet inneholde feil.) Kari bør kunne få en lese kopi selv om Per jobber med filen. (Mange systemer tillater det, men ikke alle.) Lettforståelig.

24 Versjonskontrollsystemer Ulemper: Hva om Per glemmer å legge tilbake filen? Det burde vært lov for Per og Kari å jobbe på ulike deler av filen samtidig.

25 Innsjekkingssystemer Insjekkingssystemer En bedre 1 løsning er innsjekkingssystemer: Alle kan nårsomhelst sjekke ut en kopi. Ved innsjekking kontrolleres filen mot andre innsjekkinger: Hvis endringene som er gjort ikke er i konflikt med andres endringer, blandes endringene med de tidligere. Ved konflikt får brukeren beskjed om dette og må manuelt klare opp i sakene. 1 Noen ganger er utsjekkingssystemer og låsing nødvendig: for eksempel når filene ikke er tekstfiler.

26 Innsjekkingssystemer Et scenario 1. Per sjekker ut en kopi av en fil. Han begynner å gjøre endringer i slutten av filen. 2. Kari sjekker ut en kopi av den samme filen. Hun endrer bare i begynnelsen av filen. 3. Per sjekker inn sin kopi av filen. 4. Kari sjekker inn sin kopi, og systemet finner ut at de har jobbet på hver sin del. Innsjekkingen godtas.

27 Innsjekkingssystemer Når man er alene Selv om jobber alene med et prosjekt, kan det være svært nyttig å bruke et versjonskontrollsystem: Man kan enkelt finne frem tidligere versjoner. Det kan hende man jobber på flere datamaskiner. Noen ganger lager man flere versjoner av et program, for eksempel tilpasset ulike operativsystemer. Men ofte er 90% eller mer av koden felles.

28 CVS CVS og Subversion Det mest kjente innsjekkingssystemet er CVS («Concurrent Versions System») laget i 1986 av Dick Grune. Det er veldig mye brukt i Unix miljøer. For å bøte på noen svakheter i CVS laget firmaet CollabNet Subversion i Gratis implementasjoner finnes for alle vanlige operativsystemer; se

29 Et Subversion eksempel Nære og fjerne systemer Subversion kan operere på to måter: Alt skjer i det lokale filsystemet. Man kan starte en Subversion tjener på en maskin og så sjekke inn og ut filer over nettet. Vi skal gjøre det første.

30 Et Subversion eksempel Opprette et repository Først må man opprette et «repository» der filene kan ligge: > svnadmin create ~dag/subversion/repos > ls ~dag/subversion/repos README.txt conf dav db format hooks locks

31 Et Subversion eksempel Legge inn filer Så kan vi legge inn mapper. La oss lage en gren Hei med mappen Hei som inneholder filen Hallo.java: > svn import Hei \ file:///hom/dag/subversion/repos/hei m"hei prog" Adding Hei/Hallo.java Committed revision 1. Opsjonen m gir en kort beskrivelse av denne grenen.

32 Et Subversion eksempel Sjekke ut filer Nå kan (for eksempel fra en annen mappe) hente ut mappen vår: > svn checkout file:///hom/dag/subversion/repos/hei A Hei/Hallo Checked out revision 1. > ls lr drwxr xr x 3 dag ifi a :30 Hei./Hei: rw r r 1 dag ifi a :30 Hallo.java

33 Et Subversion eksempel Sjekke inn filer Etter at filen er endret, kan vi sjekke den inn igjen: > svn commit m"nevner Java" Sending Hallo.java Transmitting file data. Committed revision 2. Vi behøver ikke nevne hvilke filer som er endret det finner Subversion ut selv. (Etter første utsjekking inneholder mappen skjulte opplysninger om repository, så det trenger vi ikke nevne mer.)

34 Et Subversion eksempel Andre nyttige kommandoer svn update. henter inn eventuelle oppdateringer fra repository. svn info viser informasjon om mappen vår: > svn info Path:. URL: file:///hom/dag/subversion/repos/hei Repository UUID: 7879acfd da1e e665dd1b40cf Revision: 2 Node Kind: directory Schedule: normal Last Changed Author: dag Last Changed Rev: 2 Last Changed Date: :29:27 (Tue, 03 Oct 2006)

35 Et Subversion eksempel svn diff viser hvilke endringer som er gjort: > svn diff Index: Hallo.java =========================================================== Hallo.java (revision 1) +++ Hallo.java (working copy) 1,5 +1,6 class Hallo { public static void main (String arg[]) { System.out.println( Hei, alle sammen! ); + System.out.println( Dette er Java! ); } }

36 Dagens lærdom Oppsummering Vi programmerer mer for mennesker enn for datamaskiner. Det betaler seg å finne frem til en god stil. make er nyttig for å sikre korrekt kompilering av store programsystem. Subversion er nyttig for å holde orden på filer og versjoner.