Pääteohjaustehtävät 5

Tässä harjoituksessa harjoitellaan debuggerin käyttöä Visual Studiossa. Opetellaan seuraavat asiat:

askeltaminen, askeltamien aliohjelman sisään (Step In) ja suorittaen aliohjelma kokonaisuutena (Step Over)
keskeytyskohdan (Breakpoint) laittaminen ja ajaminen siihen
lokaalien muuttujien (Locals) seuraaminen

Jos osaat jo debuggerin käytön hyvin tai haluat tehdä harjoituksen kotona, niin OK, siirry tekemään demoja. Mutta tee tämä harjoitus joka tapauksessa tällä viikolla ja käytä sen oppeja omissa demotehtävissä ja harkassa. Alla olevia asioita kysytään debuggausnäytteessä.

Versionhallinta (Git)

Jos et edellisessä ohjauksessa vielä tutustunut versionhallintaan, tee se nyt. Jos sinulla ei vielä ole omaa projektia kurssin etävarastossa, voit tehdä sen kohdan 3 ohjeilla. Tämän jälkeen kloonaa etävarasto omalle koneelle kohdan 6 ohjeilla.

1. Debuggaus

Lue monisteen luku 10.2 Debuggaus. Katso tehtävää tehdessä myös TIM-sivua debuggaus.

# debugmuuttujat

2. Askeltaminen debuggerissa ja lokaalit muuttujat

MacOS-käyttäjät! Näppäinoikotiet ovat oletuksena erilaiset, ne näkee Run-menun alta. Opettele oman järjestelmäsi pikanäppäimet tai vaihda näppäinoikotiet alla olevan ohjeen mukaisesti.

[9.3.2023] Jos olet ottanut käyttöön Riderin uuden UI:n niin debuggaustila ei välttämättä toimi. Vaihda siis takaisin vanhaan UI:hin tai kokeile ehdotettuja korjauksia täältä.

Rider työkalupalkki:

Alla olevat näppäinkomennot ovat Visual Studiolle. Jos Riderissa valitsit näppäinoikoteiden (hot key, keyboard shortcut) asetuksiksi Visual Studion, niin silloin nämä toimivat myös Riderissa. Riderin näppäinoikotiet saa muutettua Configure -> Settings -> Keymap tai File -> Settings -> Keymap. HUOM! Vaikka tässä kohtaa puhutaan Visual Studiosta, tehtävä tehdään Riderilla, ei Visual Studiolla eikä varsinkaan Visual Studio Codella.

Toiminto	Näppäin Win	Näppäin Mac
Debug	F5	⌥ F5
Step Into	F11	⌘ F11
Step Over	F10	F10
Resume	F5	F5
Stop debugging	Shift+F5	⇧ F5

Macin painikkeet:

⌘ = cmd
⏎ = enter
⌥ = alt
⇧ = vaihto (shift)

Huomaa, että toiminnot voi myös ohjelmoida itse melkein mihin tahansa painikkeisiin.

Aluksi harjoitellaan askeltamista eri tavoin. Samoin opetellaan seuraamaan lokaaleja muuttujia.

Tee uusi Solution (vaikkapa nimelle Demo5) ja projekti 'Debuggaus' (Console Application tai vielä mieluummin ConsoleMain joka tuli mukana kun asensit Jypeli-projektimallit).

Copy-pasteta sinne kaiken päälle seuraava sisältö:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace LaskentaaMalli
{
    public class LaskentaaMalli
    {
        public static void Main(string[] args)
        {
            double kanta = 5;
            double korkeus = 7;
            double ala;
            ala = KolmionAla(kanta, korkeus);
            System.Console.WriteLine(ala);
            System.Console.WriteLine("Valmis");
        }
        /// <summary>
        ///
        /// </summary>
        /// <param name="kanta"></param>
        /// <param name="korkeus"></param>
        /// <returns></returns>
        public static double KolmionAla(double kanta, double korkeus)
        {
            double a = kanta * korkeus / 2;
            return a;
        }
    }
}

Windows: Paina F11 tai klikkaa Debug/Step into (suomeksi askella). Ohjelma käynnistyy debuggaustilaan. Keltainen nuoli vasemmalla näyttää, mitä koodiriviä seuraavaksi suoritetaan.
Mac: Laita keskeytyskohta riville double kanta = 5;. Keskeytyskohta laitetaan klikkaamalla koodi-ikkunan vasempaan reunaan halutun rivin kohdalla, vaalean harmaalla alueella. Sitten ota menusta Run/Start Debugging. Jatkossa olevat F11 yms voivat vaihdella ja olla eri painikkeissa. Katso lyhenteet Debug tai Run-menusta.
Paina uudestaan Step into. Askellettiin riville 11. Alhaalla näkyy 'Locals'-paneeli, jossa on paikalliset muuttujat. (Jos Locals-paneelia ei näy, sen saa esille valitsemalla yläpalkista Debug -> Windows -> Locals.) args-taulukon alapuolella on kanta, korkeus ja ala, joiden arvo on tällä hetkellä 0.0.
Paina taas Step into. Ollaan rivillä 12. Kanta-muuttujan arvoksi muuttui5.0`. Visual Studio näyttää viimeksi muuttuneen arvon punaisella.
Paina niin kauan Step into, että tullaanKolmionAla-aliohjelmakutsuun. Kun vielä kerran painatStep into, hypätään riville 25 jaKolmionAla-aliohjelman sisään. Huomaatko, että Locals-paneeli muuttui, siellä ei enää ole samoja muuttujia kuinMain`-aliohjelmassa ollessamme (nyt emme enää ole Mainissa).
Huomaa myös, että rivi, jolta pomppasimme KolmionAla-aliohjelman sisään, on nyt harmaana. Näin ohjelma tietää, mille riville palataan sen jälkeen, kun KolmionAla-aliohjelman suoritus loppuu.
Sama asia selviää myös Locals-paneelin oikealla puolella olevasta Call Stack (kutsupino) -paneelista. Se ohjaa ohjelman suoritusta. Ylimpänä oleva asia suoritetaan seuraavaksi, ja alempana olevat asiat sen jälkeen.
Paina Step into niin kauan että tullaan KolmionAla-aliohjelman viimeiselle riville. Mitä luulet tapahtuvan kun vielä kerran painat Step into (Win: F11)? Ennen painamista mieti, mihin keltainen nuoli seuraavaksi osoittaa.
Klikkaa Step into niin kauan, että tullaan System.Console.WriteLine("Valmis");-riville, ja vielä kerran Step into (Win: F11).
Paina Step into niin kauan että ohjelman suoritus päättyy.
Kokeile tehdä sama homma uudestaan. Pysytkö kärryillä ohjelman suorittamisessa? Erityisen tärkeitä ovat Locals-paneeli ja Call Stack.
Jos haluat keskeyttää debuggauksen, paina Stop debugging (Win: Shift + F5).
Aloita vielä kerran ohjelman suoritus painamalla kuten alussa (WIn: F11, Mac Run/Start Debugging). Tullessasi KolmionAla-aliohjelmakutsun kohdalle (rivi 14), paina Step over (Windows: F10). Mitä tapahtui? Osaatko selittää toiminnon nimen "Step over" ja tapahtuneen välisen yhteyden?

3. Keskeytyskohta (break point)

Harjoitellaan keskeytyskohdan lisäämistä ja ajamista keskeytyskohtaan.

Tee äsken luomaasi solutioniin uusi projekti Debuggaus2 painamalla Solutionin nimen päällä hiiren oikeaa ja sitten Add New Project.
Mikäli tiedoston nimeksi tuli Program.cs muuta se nimeksi Jarjesta.cs
Kopioi alla oleva koodi ja liitä se juuri tekemäsi tiedoston sisällön tilalle

Onko riderissa tällaista "locals"-välilehteä? Ja onko tarkoitus että ConsoleWriteline-kohdassa tosiaan "step-into"?

Tekstiä korjailtu. Console.WriteLine-rivi on tarkoitus mennä Step Overilla yli. Debuggerit toimivat tässä hieman eri tavalla, Rider ottaa näköjään Step Into:n hyvin kirjaimellisesti. -AJL

— 19 Mar 24 (edited 20 Mar 24)

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace Debuggaus
{
    /// <summary>
    /// Harjoitellaan debuggerin käyttöä ja olioviitteitä.
    /// </summary>
    public class Jarjesta
    {
        /// <summary>
        /// Järjestetään taulukon 2 ekaa lukua järjetykseen.
        /// </summary>
        /// <param name="numerot">Järjestettävä taulukko.</param>
        public static void Jarjesta2(int[] numerot)
        {
            if (numerot[0] < numerot[1]) return;
            int t = numerot[0];
            numerot[0] = numerot[1];
            numerot[1] = t;
        }
        
        /// <summary>
        /// Vaihtaa, mutta ei toimi?
        /// </summary>
        /// <param name="a">1. luku</param>
        /// <param name="b">2. luku</param>
        public static void Jarjesta2(int a, int b)
        {
            if (a < b) return;
            int t = a;
            a = b;
            b = t;
        }
       
        /// <summary>
        /// Pääohjelmassa luodaan int-taulukko jossa 2 alkiota.
        /// Kutsutaan järjestä-aliohjelmia.
        /// </summary>
        /// <param name="args"></param>
        public static void Main(String[] args)
        {
                          // 0   1
            int[] luvut = { 34, 21 };
            Console.WriteLine(luvut[0] + " " + luvut[1]);
            Jarjesta2(luvut[0], luvut[1]);
            Console.WriteLine(luvut[0] + " " + luvut[1]);
            Jarjesta2(luvut);
            Console.WriteLine(luvut[0] + " " + luvut[1]);
        }
    }
}

Lue ohjelman kommentit läpi.
Laita keskeytyskohta (breakpoint) riville, jossa lukee Jarjesta2(luvut). Keskeytyskohta laitetaan klikkaamalla koodi-ikkunan vasempaan reunaan, harmaalle alueelle.
Laita ohjelma käyntiin debug-tilassa Debug/Start debugging tai Run/Satrt debugging. Ohjelman ajo keskeytyy debuggaus-tilaan riville 49.
Askella aliohjelman Jarjesta2 sisään painamalla Step Into
Avaa Threads and variables -välilehti ruudun alareunasta. numerot-muuttujan kohdalla on pieni >-merkki (kolmio tai nuolenpää, josta valintaa voi suurentaa), josta voit tarkastella muuttujassa olevia tietoja.
Askella aliohjelma läpi Step Into:lla. Hyppää kuitenkin tulostuslauseiden yli käyttäen Step Over-toimintoa.
Kun palaat pääohjelmaan, klikkaa Resume/Continue, jolloin ohjelma ajaa itsensä loppuun saakka ilman askellusta.
Poista nyt keskeytyskohta klikkaamalla punaista ympyrää.
Laita keskeytyskohta riville 47 ja debuggaa Start debugging (Win F5).
Askella jälleen aliohjelman sisään, avaa Locals-välilehti ja tutki mitä tapahtuu.
Palatessasi pääohjelmaan klikkaa Resume tai Continue, ja ohjelman suoritus menee loppuun saakka ilman askellusta.
Yritä selvittää, miksi aliohjelmakutsu Jarjesta2(luvut[0], luvut[1]) ei tee sitä mitä voisi kuvitella: pääohjelmassa tulostuu luvut alkuperäisessä järjestyksessä. Vinkki: monisteen luku 14. Olioiden ja alkeistietotyyppien erot.
Tarvittaessa breakpointtiin voidaan asettaa ehtoja (Conditional Breakpoint). Tämä tapahtuu klikkaamalla breakpointtia hiiren oikealla ja valitsemalla Condition. Tämän tekemiseen kannattaa tutustua huolella, sillä debug-näytteessä sitä kysytään. Ks. esim. Ehdollisen keskeytyskohdan laittaminen

4 String ja StringBuilder olioiden ero aliohjelmakutsussa

Tee samaan solutioniin uusi projekti Debuggaus3.
Tutki koodia:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace Olioviitteita
{
    /// <summary>
    /// Harjoitellaan olioviitteiden käyttöä.
    /// </summary>
    public class Olioviitteita
    {
        /// <summary>
        /// Luodaan String-olio ja StringBuilder-olio, ja kutsutaan aliohjelmia
        /// välittäen niille luodut oliot, ja katsotaan mitä tapahtuu.
        /// </summary>
        /// <param name="args"></param>
        public static void Main(string[] args)
        {
            StringBuilder mj1 = new StringBuilder("Janne");
            MuutaMerkkiSB(mj1);
            Console.WriteLine(mj1); // Mitä tulostuu? Miksi??
            String mj2 = "Janne";
            MuutaMerkki(mj2);
            Console.WriteLine(mj2); // Mitä tulostuu? Miksi??
        }

        /// <summary>
        /// Lisätään annetun StringBuilder-merkkijonon perään sana.
        /// </summary>
        /// <param name="a">Annettu StringBuilder-merkkijono.</param>
        public static void MuutaMerkkiSB(StringBuilder a)
        {
            a.Append(" Seppänen");           
        }
     
        /// <summary>
        /// Lisätään annetun String-merkkijonon perään sana.
        /// </summary>
        /// <param name="a">Annettu String-merkkijono.</param>
        public static void MuutaMerkki(String a)
        {
            a = a + " Seppänen";
        }       
    }
}

Älä vielä liitä koodia Visual Studioon.

Lue koodi tarkasti läpi.
Mieti, mitä tulostuu riveillä joissa lukee Mitä tulostuu?. Onko tulostuksissa jotain eroa, ja jos on, miksi?
Kopioi lopuksi koodi Visual Studioon ja tarkista asia.
Keskustele vieruskaverin kanssa, miksi ohjelma käyttäytyi niin kuin käyttäytyi.