Analise a solução para melhorar a atividade de desafio de legibilidade do código
O seguinte código é uma solução possível para o desafio da unidade anterior.
/*
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.");
Este código é apenas “uma solução possível”. Pode ter fornecido alguns nomes de variáveis diferentes, bem como espaçamento vertical e avanço de tabulação diferentes. Veja a seguir uma lista das alterações feitas.
- O código inclui uma descrição de nível superior do que toda a listagem de código está tentando realizar em um comentário de várias linhas na parte superior. Você poderia argumentar que esta é uma pequena melhoria em relação aos comentários de código originais, no entanto, dada a descrição do código do desafio, não havia muito mais contexto disponível.
- Os comentários individuais foram removidos porque não estavam fornecendo nenhuma visão real sobre o propósito ou a função do código.
- Várias linhas em branco foram adicionadas para melhorar o fraseado da listagem de código. Mantenha as linhas de código juntas quando parecerem semelhantes ou quando trabalharem umas com as outras para realizar uma pequena tarefa.
- Quebras de linha e tabulações foram adicionadas para melhorar a aparência da declaração
foreache da declaraçãoif. - Convenções de nomenclatura de variáveis locais foram aplicadas para melhor transmitir o propósito de cada valor.
Se identificou os mesmos problemas e os abordou de forma semelhante, parabéns! Avance para o teste de conhecimento na próxima unidade.
Importante
Se você teve problemas para completar este desafio, talvez você deva rever as unidades anteriores antes de continuar.