KDevelop4/Manual/Working with source code/da: Difference between revisions

From KDE UserBase Wiki
(Importing a new version from external source)
(Importing a new version from external source)
Line 164: Line 164:
[[Image:kdevelop-20.png|thumb|500px|center]]
[[Image:kdevelop-20.png|thumb|500px|center]]


Auto-completion can save you a lot of typing if your project uses long variable and function names; furthermore, it avoids mis-spelling names (and the resulting compiler errors) and it makes it much simpler to remember the exact names of functions; for example, if all of your getters start with <code>get_</code>, then the auto-completion feature will be able to only present you a list of possible getters when you have typed the first four letters, likely reminding you in the process which of the functions is the correct one. Note that for auto-completion to work, neither the declaration of the <code>Car</code> class nor of the <code>my_ride</code> variable need to be in the same file as where you are currently writing code. '''KDevelop''' simply has to know that these classes and variables are connected, i.e. the files in which these connections are made need to be part of the project you are currently working on.
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 <code>get_</code>, 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 <code>Car</code> eller variablen <code>my_ride</code>. '''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|1='''KDevelop''' doesn't always know when to assist you in completing code. If the auto-completion tooltip doesn't automatically open, hit <code>Ctrl+Space</code> to open a list of completions manually.}}
{{Note|1='''KDevelop''' doesn't always know when to assist you in completing code. If the auto-completion tooltip doesn't automatically open, hit <code>Ctrl+Space</code> to open a list of completions manually.}}

Revision as of 16:02, 28 May 2011

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 bliber 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.

</span>

{{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;
};

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:

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 doesn't always know when to assist you in completing code. If the auto-completion tooltip doesn't automatically open, hit Ctrl+Space to open a list of completions manually.


Adding new classes and implementing member functions

KDevelop has a wizard for adding new classes. To add a new class, select Code -> Create New Class to get the following dialog box:

Here, we have entered the new class's name Bus (you can also enter here which other classes this class should be derived from). The next page of the dialog allows us to select the standard member functions we will need:

Here, we want a default constructor, a copy constructor, and a destructor. After the following pages of the dialog that allow you to select a license header and the location for the new files, KDevelop will generate two new tabs with the header and source files:


The header file already has include guards and the new class has all the member functions we selected. The next two steps would be to document the class and its member functions and to implement them. We will discuss aids for documenting classes and functions below. To implement the special functions already added, simply go to the bus.cpp tab where the skeleton of functions are already provided:

To add new member functions, go back to the bus.h tab and add the name of a function. For example, let us add this:

Note how I have already started with the implementation. However, in many coding styles, the function shouldn't be implemented in the header file but rather in the corresponding .cpp file. To this end, locate the cursor on the name of the function and select Code -> Move to source or hit Ctrl+Alt+S. This remove the code between curly braces from the header file (and replaces it by a semicolon as necessary to terminate the function declaration) and moves it into the source file:

Note how I have just started typing and that I meant to imply that the students variable should probably be a member variable of class Bus but that I haven't yet added it. Note also how KDevelop underlines it to make clear that it doesn't know anything about the variable. But this problem can be solved: Clicking on the variable name yields the following tooltip:

(The same can be achieved by right clicking on it and selecting Solve: Declare As.) Let me select "3 - private unsigned int" (either by mouse, or by hitting Alt+3) and then see how it comes out in the header file:

It is worth noting that KDevelop extracts the type of the variable to be declared from the expression used to initialize it. For example, if we had written the addition in the following rather dubious way, it would had suggested to declare the variable as type double:

As a final point: The method using Code -> Move to source does not always insert the new member function where you may want it. For example, you may want it to be marked as inline and place it at the bottom of the header file. In a case like this, write the declaration and the start writing the definition of the function like this:

KDevelop automatically offers all possible completions of what might come here. Selecting one of the two add_students entries yields the following code that already fills in the complete argument list:


Note

The fact that the tooltip shows the same function twice has been reported as KDevelop Bug 274244.


Note

In the example, accepting one of the choices the auto-completion tool offers yields the correct signature but unfortunately deletes the inline marker already written. This has been reported as KDevelop Bug 274245.


Documenting declarations

Good code is well documented, both at the level of the implementation of algorithms within in functions as well as at the level of the interface — i.e., classes, (member and global) functions, and (member or global) variables need to be documented to explain their intent, possible values of arguments, pre- and postconditions, etc. As far as documenting the interface is concerned, doxygen has become the de facto standard for formatting comments that can then be extracted and displayed on searchable webpages.

KDevelop supports this style of comments by providing a short cut to generate the framework of comments that document a class or member function. For example, assume you have already written this code:

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

You now want to add documentation to both the class and the member function. To this end, move the cursor onto the first line and select Code -> Document Declaration or hit Alt+Shift+D. KDevelop will respond with the following:

The cursor is already in the grayed out area for you to fill in the short description (after the doxygen keyword @brief) of this class. You can then continue to add documentation to this comment that gives a more detailed overview of what the class does:

While the editor is inside the comment, the comment text is highlighted in green (the highlighting disappears once you move the cursor out of the comment). When you get to the end of a line, hit enter and KDevelop will automatically start a new line that starts with an asterisk and place the cursor one character indented.

Now let's document the member function, again by putting the cursor on the line of the declaration and selecting Code -> Document Declaration or hitting Alt+Shift+D:

Again, KDevelop automatically generates the skeleton of a comment, including documentation for the function itself, as well as its return type. In the current case, the name of the function is pretty much self-explanatory, but oftentimes function arguments may not be and should be documented individually. To illustrate this, let's consider a slightly more interesting function and the comment KDevelop automatically generates:

Here, the suggested comment already contains all the Doxygen fields for the individual parameters, for example.

Renaming variables, functions and classes

Sometimes, one wants to rename a function, class or variable. For example, let's say we already have this:

We then realize that we're unhappy with the name remove_students and would have rather called it, say, throw_out_students. We could do a search-replace for the name, but this has two drawbacks:

  • The function may be used in more than one file.
  • We really only want to rename this function and not touch functions that may have the same name but are declared in other classes or namespaces.

Both these problems can be solved by moving the cursor on any of the occurrences of the name of the function and selecting Code -> Rename declaration (or right clicking on the name and selecting Rename Bus::remove_students). This brings up a dialog box where you can enter the new name of the function and where you can also see all the places where the function is actually used:

Code snippets

Most projects have pieces of code that one frequently has to write in source code. Examples are: for compiler writers, a loop over all instructions; for user interface writers, checks that user input is valid and if not to open an error box; in the project of the author of these lines, it would be code of the kind

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

Rather than typing this kind of text over and over again (with all the concomitant typos one introduces), the Snippets tool of KDevelop can help here. To this end, open the tool view (see Tools and views if the corresponding button isn't already on the perimeter of your window). Then click on the "Add repository" button (a slight misnomer — it allows you to create a named collection of snippets for source codes of a particular kind, e.g. C++ sources) and create an empty repository. Then click the button with the green + to add a snippet, to get a dialog like the following:

Note

The name of a snippet may not have spaces or other special characters because it must look like a normal function or variable name (for reasons that will become clear in the next paragraph). If the name of the snippet does contain spaces, the "OK" button will become inactive without any further explanation. This has been reported as KDevelop bug 274299.


To use a snippet so defined, when you are editing code, you can just type the name of the snippet like you would any other function or variable name. This name will become available for auto-completion — which means that there is no harm in using a long and descriptive name for a snippet such as the one above — and when you accept the suggestion of the auto-completion tooltip (for example by just hitting Enter), the already entered part of the snippets' name will be replaced by the full expansion of the snippet and will be properly indented:

Note that for this to work, the Snippets tool view need not be open or visible: you only ever need the tool view to define new snippets. An alternative, if less convenient, way to expand a snippet is to simply click on it in the respective tool view.

Note

Snippets are much more powerful than just explained. For a full description of what you can do with them, see the detailed documentation of the Snippets tool.


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.
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")