Revizuiți soluția pentru a îmbunătăți activitatea de lizibilitate a codului
Următorul cod este o soluție posibilă pentru provocarea de la unitatea anterioară.
/*
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.");
Acest cod este doar "o soluție posibilă". Este posibil să fi apărut unele nume diferite de variabile și spațiere verticală diferită și indentare de tabulare. Iată o listă de modificări efectuate.
- Codul include o descriere de nivel superior a ceea ce întreaga listare de cod încearcă să realizeze într-un comentariu multi-linie în partea de sus. Puteți susține că aceasta este o mică îmbunătățire față de comentariile inițiale ale codului, cu toate acestea, având în vedere descrierea provocării codului, nu a existat mult mai mult context disponibil.
- Comentariile individuale au fost eliminate, deoarece nu furniza nicio perspectivă reală asupra scopului sau funcției codului.
- S-au adăugat mai multe linii necompletate pentru a îmbunătăți expresia listării codului. Păstrați liniile de cod împreună atunci când apar asemănătoare sau atunci când lucrează între ele pentru a efectua o activitate mică.
- S-au adăugat fluxuri de linie și file pentru a îmbunătăți aspectul instrucțiunii
foreachși a instrucțiuniiif. - Convențiile locale de denumire a variabilelor au fost aplicate pentru a transmite mai bine scopul fiecărei valori.
Dacă ați identificat aceleași probleme și le-ați tratat într-un mod similar, felicitări! Continuați verificarea cunoștințelor în unitatea următoare.
Importantă
Dacă ați avut probleme la finalizarea acestei provocări, poate ar trebui să revizuiți unitățile anterioare înainte de a continua.