Introdução
O código escrito deve comunicar sua intenção ao compilador e a outros desenvolvedores por quem ele possa ser lido. Além disso, como você é o desenvolvedor que lerá o código com mais frequência, frequentemente meses depois de ter escrito originalmente, é do seu interesse escrever um código claro e fácil de entender. Lembre-se de que você escreve o código uma vez, mas precisa lê-lo muitas vezes.
Imagine que foi solicitado que você escrevesse um código para outro grupo de desenvolvedores. Você se reúne com eles para discutir a especificação e a tarefa é clara. Após a reunião, eles informam que você trabalhará de maneira independente durante o desenvolvimento. Depois de terminar, você entregará o código para o outro grupo. A tarefa de codificação não está além do seu nível de habilidade, mas você nunca precisou escrever um código que seria mantido por outra pessoa. A equipe disse que, desde que você siga as convenções de codificação padrão para C#, não haverá problemas. Você faz planos para revisar as convenções de codificação em C# relacionadas ao código em que você trabalhará.
Neste módulo, você aprenderá a escolher nomes para suas variáveis que descrevam a finalidade e a intenção delas. Também aprenderá a adicionar comentários de código que documentem requisitos de nível superior e a abordagem que você adotou ao escrever o código, além de instruir temporariamente o compilador a ignorar algumas linhas de código específicas. Por fim, você aprenderá como o espaço em branco pode ser usado para ajudar a indicar uma relação entre as linhas de código individuais.
Ao final deste módulo, você escreverá código de modo mais propositado, concentrando-se na legibilidade e na qualidade do código para se comunicar com o compilador e outros desenvolvedores.
Importante
Este módulo inclui atividades de codificação que exigem o Visual Studio Code. Você precisará de acesso a um ambiente de desenvolvimento que tenha o Visual Studio Code instalado e configurado para o desenvolvimento de aplicativos em C#.
Objetivos de aprendizagem
Neste módulo, você vai:
- escolher um nome descritivo para variáveis que descrevam sua finalidade e intenção;
- usar comentários de código para instruir temporariamente o compilador a ignorar linhas de código;
- usar comentários de código para descrever uma finalidade ou requisitos de nível superior para uma passagem de código;
- escrever código que use espaço em branco de modo eficaz para transmitir a relação de linhas de código.
Pré-requisitos
- Experimente usar o Visual Studio Code para criar e executar aplicativos de console C#.
- Experimente imprimir mensagens no console usando
Console.WriteLine(). - Experimente usar as instruções
ifeelse ifpara criar ramificações de código.