Granska lösningen på uppgiften att förbättra kodens läsbarhet
Följande kod är en möjlig lösning på uppgiften i föregående lektion.
/*
This code reverses a message, counts the number of times
a particular character appears, then prints the results
to the console window.
*/
string originalMessage = "The quick brown fox jumps over the lazy dog.";
char[] message = originalMessage.ToCharArray();
Array.Reverse(message);
int letterCount = 0;
foreach (char letter in message)
{
if (letter == 'o')
{
letterCount++;
}
}
string newMessage = new String(message);
Console.WriteLine(newMessage);
Console.WriteLine($"'o' appears {letterCount} times.");
Den här koden är bara ”en möjlig lösning”. Du har kanske använt annorlunda variabelnamn, vertikala radavstånd och tabbindentering. Här är en lista över ändringar som har gjorts.
- Koden innehåller en beskrivning på högre nivå av vad hela kodlistan försöker åstadkomma i en flerradskommentar högst upp. Du kan hävda att detta är en liten förbättring jämfört med de ursprungliga kodkommentarerna, men med tanke på utmaningens beskrivning av koden fanns det inte mycket mer kontext tillgänglig.
- De enskilda kommentarerna togs bort eftersom de inte gav någon verklig inblick i kodens syfte eller funktion.
- Flera tomma rader har lagts till för att förbättra formuleringen av kodlistan. Håll ihop kodrader när de ser likadana ut eller när de arbetar med varandra för att utföra en liten uppgift.
- Radflöden och flikar har lagts till för att förbättra utseendet på -instruktionen
foreachoch -instruktionenif. - Namngivningskonventioner för lokala variabler tillämpades för att bättre förmedla syftet med varje värde.
Om du har identifierat samma problem och åtgärdat dem på ett liknande sätt, grattis! Fortsätt med kunskapstestet i nästa lektion.
Viktigt!
Om du har problem med att slutföra den här uppgiften kan det vara bra att gå igenom tidigare lektioner innan du fortsätter.