KDevelop4/Manual/Arbejdet med kildekode

Other languages:

Arbejdet med kildekode

Ved siden af fejlsøgning er skrivning og læsning af kildekode det, som du vil bruge mest tid med, når du udvikler software. Til dette formål giver KDevelop dig mange forskelige måder at udforske kildekoden og effektivisere skrivning af den. Som det vises i detaljer i de følgende afsnit, så er KDevelop ikke blot en kodeeditor — den er et system til at håndtere kildekode, som giver dig forskellige visninger af information, som findes i de filer, som tilsammen udgør kildekoden i din session.

Værktøjer og visninger

Til arbejdet med projekter har KDevelop begrebet værktøjer. Et værktøj giver dig en særlig visning af kildekoden eller en handling, som det kan udføre. Værktøjer repræsenteres af knapper, som findes rundt omkring i vinduets kant (med lodret tekst langs venstre og højre kant eller vandret langs bunden). Hvis du klikker på dem, så udvides de til et undervindue — en visning — indenfor hovedvinduet. Hvis du klikker på værktøjsknappen en gang til, så forsvinder visningen igen.

Note

For at få et undervindue til af forsvinde kan du også klikke på knappen x øverst til højre i undervinduet; dette fjerner dog også den tilhørende værktøjsknap fra vindueskanten, i hvert fald i KDevelop 4.2.x; og den skal du bruge for at få undervinduet frem igen. Se herunder, hvordan du får knappen tilbage til vindueskanten på samme måde, som du får enhver anden værktøjsknap placeret der. Denne opførsel er rapporteret som bug 270018

Billedet ovenfor viser et eksempel på værktøjer placeret i den venstre og højre kant. I billeder er værktøjet Klasser åbent til venstre og værktøjet Tekststumper til højre sammen med en editor til en kildefil i midten. For det meste vil du nok kun have editoren åben og måske værktøjet Klasser eller Kodebrowser til venstre. Andre værktøjer vil sikkert kun være åbne midlertidigt mens du bruger dem, sådan at der bliver mere plads til editoren.

Når du kører KDevelop første gang, så skulle du allerede have værktøjsknappen Projekter. Klik på den: det vil åbne et undervindue, som forneden viser de projekter, som du har føjet til sessionen og en visning af mapperne i dit projekt for oven.

Der er mange andre værktøjer, som du kan bruge i KDevelop, men deres knapper er ikke alle til stede i vindueskanten fra begyndelsen. For at føje flere til vælger du menuen Vindue -> Tilføj værktøjsvisning.... Her er nogle, som du sikkert vil få glæde af:

Klasser: En fuldstændig liste af alle klasser, som bliver defineret i en af din sessions projekter med alle deres medlemsfunktioner og -variable. Klik på et medlem for at åbne kildeeditorens vindue med markøren på det sted, hvor det emne, du klikkede på er defineret.

Dokumenter: Viser de filer, som du for nylig har arbejdet med ordnet efter type (fx kildefil, patchfil eller rent tekstdokument).

Kodebrowser: Dette værktøj viser ting, der er relaterede til det, som du aktuelt arbejder med afhængigt af, hvor markøren er placeret. Hvis den fx er på en #include linje, så vises information om den fil der bliver inkluderet, så som hvilke klasser, der erklæres i filen; hvis du er på en tom linje på filniveau, så vises de klasser og funktioner, som erklæres eller defineres i den aktuelle fil (alle vises som links: klikker du på dem, så bringes du til det sted i filen, hvor erklæringen eller definitionen er); hvis du er i en funktionsdefinition, så vises der, hvor funktionen erklæres og hvor den bruges.

Filsystem: Giver dig en trævisning af filsystemet.

Dokumentation: Lader dig søge efter man-sider og andre hjælpedokumenter.

Tekststumper: Her kan du gemme tekststumper, som du ofte har brug for og ikke har lyst til at skulle skrive hver gang. I projektet, som vises i billedet ovenfor er der ofte brug for kode som dette:
for (typename Triangulation<dim>::active_cell_iterator cell = triangulation.begin_active(); cell != triangulation.end(); ++cell)
Det er besværligt udtryk, med det ser næsten ud på samme måde, hver gang du har brug for sådan en løkke. Det gør udtrykket til en god kandidat til en tekststump.

Konsole: Åbner et vindue med en kommandolinje i KDevelops hovedvindue til de situationer, hvor du blot skal have udført enkelte kommandoer (fx hvis du skal køre ./configure).

En fuldstændig liste med værktøjer og visninger findes her.

For mange programmører er det vigtigst at have god plads i lodret retning. For at opnå dette kan du arrangere dine værktøjsvisninger i venstre og højre vindueskant. For at flytte et værktøj højreklikker du på dets knap og vælger en ny position til det.

Udforsk kildekoden

Lokal information

KDevelop forstår kildekode og er derfor virkelig god til at at give dig information om variable eller funktioner, som kan optræde i dit program. Her er for eksempel et øjebliksbillede af arbejdet med et stump kode, hvor musen svæver over symbolet cell i linje 1316 (hvis du foretrækker at bruge tastaturet, så kan du opnå det samme ved at holde Alt-tasten nede et stykke tid):

KDevelop viser dig et værktøjstip, som inkluderer variablens type (her DoFHandler<dim&rt;active_cell_iterator), hvor denne variabel er erklæret (hvad den er indeholdt i — her den omgivende funktion get_maximal_velocity, eftersom det er en lokal variabel, ikke en funktion, klasse eller navnerum) og hvor den er erklæret (i linje 1314, blot nogle få linjer oppe i koden).

I den aktuelle sammenhæng har symbolet, som musen svæver over ingen tilknyttet dokumentation. Hvis musen havde svævet over symbolet get_this_mpi_process i linje 1318 i dette eksempel, så ville det have set sådan ud:

Her har KDevelop henvist til erklæringen i en anden fil (utilities.h, som endda hører til et andet projekt i den samme session) og vist den doxygen-agtige kommentar, som er knyttet til erklæringen der.

Hvad der gør disse værktøjstips endnu nyttigere er, at de er dynamiske: Du kan klikke på linket Container for at få information om den kontekst, som variablen er erklæret i (fx om navnerummet System, så som hvor det bliver erklæret, defineret, brugt eller hvad dets dokumentation er) og du kan klikke på det blå link for at få flyttet tekstmarkøren hen til symbolets erklæring (i eksemplet til linje 289 i utilities) eller få en liste over steder, hvor dette symbol bruges i den aktuelle fil eller overalt i projekterne, som hører den aktuelle session. Det sidste er ofte nyttigt, hvis du for eksempel vil undersøge, hvordan en given funktion bruges i en større kodebase.

Note

Informationen i værktøjstippet er flygtig — den er afhængig af, at du holder Alt-tasten nede eller holder musen svævende. Hvis du ønsker et mere permanent visning, så åbn værktøjsvisningen Kodebrowser i et af undervinduerne. For eksempel er markøren her på samme funktion som i eksemplet ovenfor og værktøjsvisningen til venstre giver den samme slags information som værktøjstippet før:

Flytter du mærkøren rundt i vinduet til højre, så ændres informationen tilsvarende i visningen til venstre. Desuden kan du klikke på knappen Lås nuværende visning øverst til højre i Kodebrowseren for at fastholde informationen og dermed gøre den uafhængig af markørens bevægelse mens du udforsker den givne information.

Note

Denne slags kontekstafhængig information er tilgængelig mange steder i KDevelop, ikke kun i kodeeditoren. Holder du for eksempel Alt-tasten nede, mens markøren er i en liste med forslag til færdiggørelse (fx når du foretager en hurtig åbning), så får du også information om det aktuelle symbol.

Information på filniveau

Går vi et niveau op, så kan du få information om hele den aktuelle kildefil ved at placere markøren i en linje på filniveau og se hvad værktøjsvisningen Kodebrowser viser:

Her vises en liste med navnerum, klasser og funktioner, som bliver erklæret eller defineret i den akuelle fil. Det giver dig et overblik over, hvad der sker i denne fil og en måde til hoppe direkte til enhver af disse erklæringer eller definitioner uden at skulle rulle op eller ned i filen eller søge efter et bestemt symbol.

Note

Informationen til at navigere i kildekoden, som vises på filniveau er den samme, som du får i tilstanden Omrids, som omtales nedenfor; forskellen er, at tilstanden Omrids kun er et midlertidigt værktøjstip.

Information om projekter og sessioner

Der er mange måder at få information om et helt projekt (eller endda om alle projekter i en session). Den slags information gives som regel i en værktøjsvisning. For eksempel giver værktøjsvisningen Klasser dig en træstruktur over alle klasser og omgivende navnerum for alle projekter i en session sammen med hver enkelt klasses medlemsfunktioner og -variable:

Lader du musen svæve over et emne, så får du igen information om symbolet, hvor det bliver erklæret, defineret og brugt. Dobbeltklikker du på et emne i trævisningen, så åbnes et editorvindue med markøren placeret der, hvor symbolet bliver erklæret eller defineret.

Med der er andre måder at få vist global information. For eksempel giver værktøjsvisningen Dokumenter en oversigt over et projekt i form af de forskellige slags filer eller andre dokumenter, som indgår i projektet:

Bevæg dig rundt i kildekoden

I det forrige afsnit har vi fortalt, hvordan man udforsker kildekoden, dvs. får information om symboler, filer og projekter. Næste skridt er at bevæge sig rundt i kildekoden. Der er igen forskellige niveauer, som det kan foregå på: lokalt, på filniveau og indenfor et helt projekt.

Note

Mange af de måder, som man kan navigere i koden på er tilgængelige i menuen Navigér i KDevelops hovedvindue.

Lokal navigation

KDevelop er meget mere end en editor, men den er også er kildeeditor. Som sådan kan du selvfølge flytte markøren op, ned og til højre og venstre i kildefilen. Du kan også bruge tasterne PageUp og PageDown og alle de andre kommandoer, som du kender det fra enhver brugbar editor.

Navigatio på filniveau og i omrids-tilstand

På filniveau har KDevelop mange måder at navigere igennem kildekoden på, herunder følgende metoder til at hoppe rundt i en given fil:

Omrids: Du kan få et overblik over, hvad der er i den aktuelle fil på mindst tre forskellige måder:
- Ved at klikke i tekstboksen Omrids øverst til højre i hovedvinduet eller taste Alt + Ctrl + N åbner du en dropned-liste med alle funktions- og klasseerklæringer:
  
  Du kan så vælge at hoppe til en af dem eller — hvis der er mange — begynde at skrive, hvorved listen bliver mindre og mindre efterhånden som de emner, som ikke passer med det du har skrevet forsvinder fra listen.
- Placér markøren på i linje på filniveau (dvs. udenfor erklæringer og definitioner af funktioner og klasser) mens værktøjsvisningen Kodebrowser er åben:
  
  Dette giver dig også et oberblik over den aktuelle fil og lader dig vælge, hvor du vil hoppe til.
- Lader du musen svæve over fanebladet for en af de åbne filer, så får du også et omrids af filen i dette faneblad.

Kildefiler er organiserede som en liste af erklæringer og definitioner af funktioner. Taster du Alt + Ctrl + PgUp eller Alt + Ctrl + PgDown, så hopper du til den forrige eller næste funktionsdefinition i denne fil.

Navigation i projekter og sessioner: Semantisk navigation

Som nævnt andetsteds arbejder KDevelop normalt ikke men enkelte kildefiler men ser på projekter som et hele (eller snarere med alle de projekter, som er en del af den aktuelle session). Som konsekvens af det giver den dig mange muligheder for at navigere igennem hele projekter. Nogle af disse muligheder er afledt af de funktioner, som vi allerede har omtalt i afsnittet Udforsk kildekoden, mens andre er helt nye. Det fælles tema er, at disse navigationsfunktioner er baseret på en semantisk forståelse af kildekoden, dvs. at hele projekteer med tilhørende data skal parses, for at de skal kunne fungere. Den følgende liste viser nogle af måderne, på hvilke du kan navigere igennem kildekode, som kan være spredt ud over et potentielt meget stort antal filer:

Som vi så i afsnittet Udforsk kildekoden kan du få et værktøjstip, som forklarer individuelle navnerum, klasser, funktioner og variable ved at lade musen svæve over deres navn eller holde Alt-tasten nede et stykke tid. Her er et eksempel:

Klikker du på linkene for et symbols erklæring eller udvider du listen med anvendelser, så kan du hoppe til disse steder — den relevante fil åbnes, hvis det er nødvendigt — og placere markøren på det tilsvarende sted. En lignende effekt kan opnås ved at bruge værktøjsvisningen Kodebrowser, som også er omtalt tidligere.

Åbn hurtigt: De forskellige åbn hurtigt-metoder i KDevelop giver dig kraftfulde måder at hoppe til andre filer eller steder. Der er fire af dem:
- Åbn klasse hurtigt (Navigation -> Åbn klasse hurtigt eller Alt + Ctrl + C): Du vil få en liste med alle klasserne i denne session. Når du begynd at skrive (en del af) klassens navn, så skrumper listen ind til kun at indeholde de klasser, hvis navne matcher det, som du har skrevet indtil nu. Når listen er kort nok, så kan du vælge et element ved brug af pil op- og ned-tasterne og KDevelop vil tage dig til det sted, hvor klassen bliver erklæret.
- Åbn funktion hurtigt (Navigation -> Åbn funktion hurtigt eller Alt + Ctrl + M): Du vil få en liste med alle (medlems)funktionerne, som indgår i projekterne i den aktuelle session, og du kan vælge fra listen på samme måde som ovenfor. Bemærk, at listen kan inkludere både funktionserklæringer og -definitioner.
- Åbn fil hurtigt (Navigation -> Åbn fil hurtigt eller Alt + Ctrl + O): Du vil få en liste med alle filerne, som indgår i projekterne i den aktuelle session, og du kan vælge fra listen på samme måde som ovenfor.
- Universel åbn hurtigt (Navigation -> Åbn hurtigt eller Alt + Ctrl + Q): Hvis du glemmer, hvilken tastaturgenvej, der er bundet til hvilken af de foregående metoder, så er dette den universelle schweizerkniv — den giver dig en liste med alle filer, funktioner, klasser og andre ting, som du kan vælge fra.

Spring til erklæring eller definition: Når man implementerer en (medlems)funktion, så har man ofte brug for at hoppe tilbage til det sted, hvor funktionen bliver erklæret for eksempel for at holde argumentlisten i funktionserklæringen synkroniseret med funktionsdefinition eller for at opdatere dokumentationen. For at gøre dette placerer du markøren på funktionens navn og vælger menuen Navigation -> Spring til erklæring (eller tast <kaycap>Ctrl + .</keycap>) for at komme til det sted, hvor funktionen bliver erklæret. Der er flere måder at komme tilbage til det oprindelige sted:
- Vælg menuen Navigation -> Spring til definitionen (eller tast Ctrl + ,).
- Vælg menuen Navigation -> Forrige besøgte kontekst (eller tast Meta + pil til venstre</menuchoice>) som beskrevet længere nede.

{{Note/da|1=At springe til erklæringen af et symbol virker ikke blot med navne på funktioner, som du er i færd med at implementere. Det fungerer også med andre symboler: Placér markøren på en (lokal, global eller medlems-) variabel og hop til dens erklæring. På samme måde kan du placere markøren på en klasses navn for eksempel i en variabel eller funktionserklæring og hoppe til stedet, hvor den bliver erklæret.}}

'''Skift definering/erklæring''': I ovenstående eksempel skulle du først placere markøren på funktionens navn for at hoppe til erklæringen. For at undgå dette kan du vælge menuen <menuchoice>Navigation -> Skift definering/erklæring</menuchoice> (eller taste <keycap>Shift + Ctrl +C) for at hoppe til erklæringen af den funktion, som markøren aktuelt befinder sig i. Vælg det samme menupunkt en gang til for at komme tilbage til det sted, hvor funktionen bliver defineret.

Forrige eller næste brugstilfælde: Placér markøren på en lokal variabels navn og vælg menuen Navigation -> Næste brugstilfælde (eller tast Meta + Shift + pil til højre) for at hoppe til det næste sted, hvor variablen bruges. (Bemærk, at dette ikke blot søger efter fremkomster af variabelnavnet, men faktisk tager højde for, at variable med det samme navn men udenfor den aktuelle rækkevidde ikke er anvendelser af den samme variabel.) Det samme kan du gøre med funktionsnavne. Vælg menuen Navigation -> Forrige brugstilfælde (eller tast Meta + Shift + pil til venstre) for at komme til en tidligere anvendelse af symbolet.

Note

For at se en liste med alle anvendelser af et navn, som disse kommandoer bevæger sig rundt imellem kan du placere markøren på navnet, åbne værktøjsvisningen Kodebrowser og holde Alt-tasten nede. Dette forklares i mere detalje i afsnittet om at udforske kildekoden.

Kontekstlisten: Webbrowsere har en funktion, hvor du kan gå frem og tilbage i listen over de senest besøgte sider. KDevelop har den samme slags funktion, hvor du istedet for websider besøger kontekster. En kontekst er markørens aktuelle position, og du ændrer konteksten ved enhver form for navigering bortset fra markørkommandoerne — for eksempel ved at klikke på et link i et værktøjstip eller i værktøjsvisningen Kodebrowser, vælge et punkt i menuen Navigation eller bruge en af de andre navigationskommandoer. Brug menuerne Navigation -> Forrige besøgte kontekst (Meta + pil til venstre) og Navigation -> Næste besøgte kontekst (Meta + pil til højre) til at gå igennem listen af besøgte kontekster ligesom Frem- og Tilbage-knapperne i en browser fører dig frem og tilbage i listen af besøgte websider.

Endelig er der værktøjsvisninger, som lader dig navigere til forskellige steder i din kodebase. For eksempel giver værktøjsvisningen Klasser en liste med alle navnerum og klasser i alle projekter i den aktuelle session og lader dig folde listen ud, sådan at du kan se hver klasses medlemsfunktioner og -variable:
Du kan hoppe til edt sted, hvor et punkt erklæres ved at dobbeltklikke på de (eller bruge kontekstmenuen ved at højreklikke). Andre værktøjer har lignende funktioner; for eksempel giver værktøjsvisningen Projekter en liste med filer, som indgår i sessionen:
Igen åbner du en fil ved at dobbeltklikke på den.

Skriv kildekode

Eftersom KDevelop forstår dit projekts kildekode, så kan den hjælpe dig med at skrive yderligere kode. I det følgende skitseres nogle af de måder, som det sker på.

Automatisk fuldførelse

Automatisk fuldførelse er nok den nyttigste af alle funktionerne til at skrive ny kode er. Betragt for eksempel følge stump kode:

class Car {
  // ...
  public:
    std::string get_color () const;
};

void foo() 
{
  Car my_ride;
  // ...do something with this variable...
  std::string color = my_ride.ge

I den sidste linje vil KDevelop huske, at variablen my_ride er af typen Car og vil automatisk tilbyde at færdiggøre navnet på medlemsfunktionen ge til get_color. Alt havd du behøver at gøre er faktisk at skrive, indtil funktionentil automatisk fuldførelse har reduceret antallet af matchende funktioner til en og så taste Enter:

Bemærk, at du kan klikke på værktøjstippet for at få mere information om funktionen ud over dens returtype og om den er "public":

Automatisk fuldførelse kan spare dig en masse tasteanslag, hvis dit projekt bruger lange variabel- og funktionsnavne; desuden hjælper det med at undgå skrivefejl i navne (med dertil hørende compilerfejl), og det gør det meget lettere at huske funktionernes præcise navne. Hvis for eksempel alle dine getter-funktioners navne starter med get_, så bliver funktionen til automatisk fuldførelse i stand til at præsentere dig for en liste, som kun indeholder mulige gettere, efter at du blot har tastet de første fire bogstaver i navnet; i den forbindelse vil du nok blive mindet om, hvilken af funktionerne, der er den rigtige. Bemærk, at automatisk fuldførelse virker selv hvis den aktuelle fil hverken indeholder erklæringerne af klassen Car eller variablen my_ride. KDevelop skal blot vide, at disse klasser og variable er tilknyttede, dvs. at filerne, hvor de bliver erklærede skal være en del af projektet, som du aktuelt arbejder på.

Note

KDevelop ved ikke altid, hvornår den skal hjælpe dig med at fuldføre kode. Hvis tooltippet med automatiske fuldførelse ikke åbnes automatisk, så tast Ctrl + Mellemrum for manuelt at åbne en liste med mulige fuldførelser. For at kunne udfør automatisk fuldførelse skal KDevelop fortolke din kildefil. Dette sker i baggrunden for alle filer, som hører til projekterne i den aktuelle session efter at du starter KDevelop samt når du stopper med at skrive i en brøkdel af et sekund (forsinkelsen kan indstilles).

Note

KDevelop fortolker kun filer, som den betragter som kildekode, hvilket bestemmes af filens MIME-type. Denne type er ikke fastast før efter at filen er belvet gemt en gang; når du laver en ny fil og begynder at skrive kode i den, så udløser det ikke fortolkning med henblik på automatisk fuldførelse før efter, at filen er blevet gemt første gang.

Når det er sagt, så betyder det ikke, at der ikke er nogen form for automatisk fuldførelse. Her...

...foreslår KDevelops indbyggede editor (Kate) for eksempel simpelt hen et af de ord, som den tidligere har set i den aktuelle fil. Der er dog ingen syntaktisk kontekst involveret, som det ses af fraværet af returtypen i værktøjstippet.

Tilføj nye klasser og implementér medlemsfunktioner

KDevelop her en guide til at tilføje nye klasser. For at tilføje en ny klasse vælger du menuen Kode -> Opret ny klasse for at få følgende dialog frem:

Her har vi indtastet den nye klasses navn Bus (her kan du også angive, hvilke andre klasser denne klasse skal arve fra). Den næste side i dialogen lader dig vælge de standard-medlemsfunktoner, som du får brug for:

Her ønsker vi en standark-konstruktøe og en destruktør. De næste sider i dialogen lader dig vælge en header til licensbetingelser og placeringen af de nye filer. Herefter genererer KDevelop to nye faneblade med header- og kildefilen:

Headerfilen har allerede et "include-værn", og den nye klasse har alle de medlemsfunktioner, som vi valgte. De næste to skridt ville være at dokumentere klassen og dens medlemmer og at implementere dem. Vi vil diskutere funktionerne til at hjælpe med dokumentation nedenfor. For at implementere de funktioner, som allerede er tilføjet går du simpelt hen til fanebladet bus.cpp, hvor de allerede findes:

For at tilføje nye medlemsfunktioner går du tilbage til fanebladet bus.h og tilføjer funktionens navn. Lad os for eksempel tilføje dette:

Bemærk, at jeg allered er begyndt at implementere. I mange kodningsstile skal funktioner dog ikke implementeres i headeren men snarere i den tilhørende .cpp-fil. For at gøre dette placerer du markøren på funktionens navn og vælger Kode -> Flyt ind i kilden eller tast Ctrl + Alt + S. Dette fjerner koden mellem de krøllede parenteser fra headerfilen (og erstatter den med et semikolon, som skal til for at afslutte funktionserklæringen) og flytter den ind i kildefilen:

Bemærk, at jeg blot er begyndt at skrive, og at jeg forventer, at variablen students sandsynligvis skal være en medlemsvariabel i klassen Bus, men at jeg ikke har tilføjet den endnu. Bemærk også hvordan KDevelop understreger variablen for at gøre det klart, at den endnu ikke ved noget om variablen. Men dette problem kan løses: Klik på variablens navn for at få følgende værktøjstip frem:

(Det samme kan opnås ved at højreklikke på navnet og vælge Løs: Erklær som.) Lad mig vælge 3 - private unsigned int (enten med musen eller ved at taste Alt + 3) og se, hvordan det viser sig i headerfilen:

Det er værd at bemærke, at KDevelop udleder den type, som variablen skal erklæres til fra det udtryk, som bruges til at initialisere den. Hvis vi for eksempel havde skrevet følgende tvivlsomme tilføjelse, så ville den have foreslået at erklære variablen som typen double:

En sidste bemærkning: Funktionen Kode -> Flyt ind i kilden indsætter ikke altid medlemsfunktonen der, hvor du ønsker den. For eksempel ønsker du måske at den bliver markeret som inline og placeret nederst i headerfilen. I sådan et tilfælde kan du skrive erklæringen og begynde at skrive funktionsdefinitionen sådan her:

KDevelop giver dig automatisk alle de mulige fuldførelser af, hvad der kan komme her. Vælg et af de to punkter med add_students for at få følgende kode, som allerede udfylder den fuldstændige liste af argumenter:

Note

Det, at værktøjstippet viser det samme navn to gange er rettet i KDevelop 4.2.2 og senere.

Note

Hvis du i eksemplet accepterer en af de muligheder, som den automatiske fuldførelse tilbyder, så får du den korrekte signatur, men desværre slettes nøgleordet inline, som du allerede har skrevet. Dette er blevet rapporteret som KDevelop Bug 274245.

Dokumentation af erklæringer

God kode har god dokumentation både af funktionernes implementering af algoritmer og af interfacet — dvs. klasser (medlems- og globale) funktioner og (medlems- og globale) variable skal dokumenteres for at forklare deres formål, mulige værdier af argumenter, pre- og postbetingelser osv. Med hensyn til dokumentation af interfacet er doxygen blevet en de facto-standard for formatering af kommentarer, som kan trækkes ud og vises i søgbare websider.

KDevelop understøtter denne kommentarstil ved at give dig en genvej til at generere en skabelon til kommentarer, som dokumenterer en klasse eller medlemsfunktion. Antag for eksempel, at du allerede har skrevet denne kode:

class Car {
  public:
    std::string get_color () const;
};

Nu vil du føje dokumentation til både klasse og medlemsfunktioner. For at gøre det flytter du markøren hen på første linje og vælger menuen Kode -> Dokumentér erklæring eller taster Alt + Shift + D. KDevelop vil reagere ved at tilføje følgende:

Markøren er allerede i det grå område, sådan at du kan skrive en kort beskrivelse af denne klasse (efter doxygen-nøgleordet @brief). Du kan så fortsætte med at føje mere detaljeret dokumentation til denne kommentar.

Mens markøren er inde i kommentaren, er teksten fremhævet med grønt (fremhævningen forsvinder, når du flytter markøren ud af kommentaren). Når du kommer til slutningen af en linje taster du Enter, så vil KDevelop automatisk starte en ny linje, som begynder med en asterisk og placere markøren et tegn længere inde.

Lad os nu dokumentere medlemsfunktionen. Flyt markøren til den linje, hvor funktionen erklæres og vælg menuen Kode -> Dokumentér erklæring ellet tast Alt + Shift D:

Igen genererer KDevelop automatisk en kommentarskabelon, som inkluderer dokumentation af funktionen selv og af dens returtype. I det aktuelle tilfælde er fuktionens navn ret selvforklarende, men det er tit ikke tilfældet med argumenterne, så de skal dokumenteres hver for sig. For at illustrere dette betragter vi ee lidt mere interessant funktion og kommentaren, som KDevelop genererer automatisk:

Her indeholder den foreslåede kommentar for eksempel allerede Doxygen-felterne til de enkelte parametre.

Omdøb variable, funktioner og klasser

Undertiden ønsker man at omdøbe en funktion, klasse eller variabel. Lad os for eksempel sige, at du allerede har dette:

Du opdager så, at du ikke er glad for funktionsnavnet remove_students og fx hellere ville have kaldt den throw_out_students. Du kunne foretage en søgning-og-erstatning efter navnet, den det hat to ulemper:

Funktionen bliver måske bruge i flere filer.

Vi vil kun omdøbe denne funktion og ikke berøre andre funktioner, som måske har samme navn men bliver erklærede i andre klasser eller navnerum.

Begge disse problemer kan løses ved at flytte markøren hen på et hvilken som helst sted, hvor funktionsnavnet optræder og så vælge menuen Kode -> Omdøb erklæring (eller højreklik på navnet og vælg Omdøb Bus::remove_students). Dette får en dialog til at dukke op, hvor du kan angive funktionens nye navn, og hvor du også kan se alle de steder, hvor funktionen faktisk bruges:

Tekststumper

De fleste projekter har kodestumper, som man ofte har brug for at skrive i kildekoden. Nogle eksempler: skriver man en kompiler, så har man brug for løkker over alle instruktioner; til en brugerflade skal man tjekke, at brugerinput er gyldigt og åbne en fejlmeddelelsesboks hvis ikke; i mit eget projekt forekommer denne slags linjer ofte:

for (typename Triangulation<dim,spacedim>::active_cell_iterator
       cell = triangulation.begin_active();
     cell != triangulation.end(); ++cell)
  ... do something with the cell ...

I stedet for at skrive denne tekst igen og igen (med alle de muligheder for tastefejl, som det medfører), så kan værktøjet Tekststumper være nyttigt her. Åbn værktøjsvisningen (se Værktøjer og visninger, hvis den tilsvarende knap ikke allerede findes i vindueskanten). Klik så på knappen Tilføj depot (et lidt misvisende navn — med den kan du lave en navngiven samling af tekststumper til en bestemt slags kildekode, fx C++) og lav et tomt depot. Klik så på knappen med det grønne + for at kalde følgende dialog frem:

Note

Tekststumpens navn må ikke indeholde blanktegn eller andre specielle tegn, fordi den skal ligne et almindeligt navn på en funktion eller variabel (det vil blive klart hvorfor i næste afsnit). Hvis navnet på en tekststump indeholder blanktegn, så bliver knappen O.k. blive inaktiv uden yderligere forklaring. Dette er blevet rapporteret som KDevelop bug 274299.

Når du skriver kode og skal bruge en tekststump, så skriver du blot tekststumpens navn på samme måde, som du ville med enhver funktion eller variabel. Navnet bliver så tilgængeligt for automatisk fuldførelse — det betyder, at du uden problemer kan bruge lange og beskrivende navne til tekststumper, som den ovenfor — og når du accepterer forslaget i værktøjstippet til automatisk fuldførelse (ved for eksempel at taste Enter), så bliver den allerede indtastede del af tekststumpens navn erstattet af tekststumpens fulde indhold, som bliver korrekt indrykket:

Bemærk, at værktøjsvisningen Tekststumper ikke behøver at være åben for at dette skal virke: du har kun brug for værktøjsvisningen når du skal definere nye tekststumper. En alternativ, men måske knap så bekvem måde at indsætte tekststumper er simpelt hen at klikke på den i værktøjsvisningen.

Note

Tekststumper kan meget mere, end hvad der lige er blevet forklaret. En fuld beskrivelse af, hvad du kan gøre med tekststumper finder du i den detaljerede dokumentation af værktøjet Tekststumper.

Tilstande og arbejdssæt

Hvis du er kommet så langt, så se lidt på øverste højre hjørne af KDevelops hovedvindue. Som det ses i billedet finder du her de tre tilstande, som KDevelop kan være i: Kode (den tilstand, som vi diskuterer i dette kapitel om arbejdet med kildekoden), Fejlsøgning (se Fejlsøgning af programmer) og Eftersyn (se Arbejdet med versionskontrolsystemer).

Hver tilstand har sit eget sæt af værktøjer i vindueskanten og sit eget arbejdssæt af aktuelt åbne filer og dokumenter. Desuden er hvert arbejdssæt knyttet til en session, svarende til den sammenhæng, der vises i billedet ovenfor. Bemærk, at filerne i arbejdssættet hører til samme session med kan komme fra forskellige projekter, som hører til samme session.

Hvis du åbner KDevelop for første gang, så er arbejdssættet tomt — der er ingen åbne filer. Men idet du åbner filer for redigering (eller fejlsøgning eller eftersyn i de andre tilstande), så vokser dit arbejdssæt. Som du kan se på billedet herunder, så viser et symbol i fanebladet at arbejdssættet ikke er tomt. Bemærk, at nå du lukker KDevelop, gemmes arbejdssættet og det genetableres, når du genstarter programmet, dvs. at du får det samme sæt af åbne filer.

Hvis du lader musen svæve over symbolet for et arbejdssæt, så dukker der et værktøjstip frem, som viser dig hvilke filer, der aktuelt er åbne i dette arbejdssæt (her filerne step-32.cc og step-1.cc). Klikker du på det røde minustegn, så lukkes fanebladet med den tilsvarende fil. Klikker du på Luk, så lukkes hele arbejdssættet på en gang (dvs. alle åbne filer lukkes). Pointen med at lukke et arbejdssæt er, at det ikke bare lukker alle filer men faktisk gemmer det og åbner et nyt, endnu tomt sæt. Det kan du se her:

Bemærk de to symboler til venstre for det tre tilstandsfaneblade (hjertet og det uidentificérbare symbol til venstre for det). Hver af disse symboler repræsenterer et gemt arbejdssæt. Hvis du lader musen svæve over hjertesymbolet, så ser du noget i retning af dette:

Det viser dig, at det tilsvarende arbejdssæt indeholder to filer og deres tilsvarende projektnavne: Makefile og changes.h. Klikker du på Indlæs, så gemmes og lukkes det aktuelle arbejdssæt (i eksemplet her har det filerne tria.h og tria.cc åbne) og åbner i stedet det valgte arbejdssæt. Du kan også slette et arbejdssæt permanent.

Nogle nyttige tastaturgenveje

KDevelops editor bruger standard-tastaturgenveje til alle almindelige redigeringsoperationer. Den understøtter dog også et antal mere avancerede operationer, når man redigerer kode; nogle af disse er bundet til forskellige tastekombinationer. De følgende er ofte nyttige:

Hop rundt i kildekode
Ctrl+Alt+O	Åbn fil hurtigt: skriv en del af et filnavn og vælg blandt alle de filer i den aktuelle sessions projektmapper, som matcher strengen; filen bliver så åbnet
Ctrl+Alt+C	Åbn klasse hurtigt: skriv en del af navnet på en klasse og vælg imellem de klasser der matcher; markøren vil hoppe til det sted, hvor klassen erklæres
Ctrl+Alt+M	Åbn funktion hurtigt: skriv en del af navnet på en (medlems)funktion og vælg imellem de funktioner der matcher. Bemærk, at listen både viser erklæringer og definitioner. Markøren vil hoppe til det valgte sted
Ctrl+Alt+Q	Åbn hurtigt: skriv hvad som helst (filnavn, klassenavn, funktionsnavn) og få en liste over alt det, der matcher til at vælge fra
Ctrl+Alt+N	Oversigt: Vis en liste over alt, hvad der sker i denne fil, dvs. klasseerklæringer og funktionsdefinitioner
Ctrl+,	Hop til definitionen af en funktion, hvis markøren i øjeblikket er på en funktionserklæring
Ctrl+.	Hop til en erklæring af en funktion eller variabel hvis markøren i øjeblikket er i en funktionsdefinition
Ctrl+Alt+PageDown	Hop til den næste funktion
Ctrl+Alt+PageUp	Hop til den forrige funktion
Ctrl+G	Gå til linje
Søg og erstat
Ctrl+F	Find
F3	Find næste
Ctrl+R	Erstat
Ctrl+Alt+F	Find og erstat i flere filer
Andre ting
Ctrl+_	Fold et lokalt niveau sammen: skjul denne blok, for eksempel hvis du ønsker at fokusere på det overordnede billede i en funktion
Ctrl++	Udfold et lokalt niveau: Omgør sammenfoldning
Ctrl+D	Udkommentér den markerede tekst eller den aktuelle linje
Ctrl+Shift+D	Fjern udkommentering af den markerede tekst eller den aktuelle linje
Alt+Shift+D	Dokumentér erklæring. Hvis markøren er på erklæringen af en funktion eller klasse, så laves der en doxygen-agtig kommentar med alle funktionens parametre, returværdi osv.
Ctrl+T	Byt det aktuelle og det forrige tegn
Ctrl+K	Slet den aktuelle linje (bemærk: dette er ikke emacs' "slet herfra og til linjens afslutning")