Introdução
O código que você escreve deve comunicar sua intenção ao compilador e a outros desenvolvedores que talvez precisem ler seu código. E como você é o desenvolvedor que lerá seu código com mais frequência, às vezes meses depois de tê-lo escrito originalmente, é do seu interesse escrever um código claro e fácil de entender. Lembre-se, você pode escrever código uma vez, mas você precisará lê-lo muitas vezes.
Suponha que você tenha sido solicitado a escrever algum código para outro grupo de desenvolvedores. Você se reúne com eles para discutir a especificação e a atribuição é clara. Após a reunião, eles dizem que você trabalhará de forma independente durante o desenvolvimento. Quando terminar, você entregará seu 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 teve que escrever código que outra pessoa estará mantendo. A equipe disse que, desde que você siga as convenções de codificação padrão para C#, não deve haver problema. Você faz planos para revisar as convenções de codificação em C# relacionadas ao código no qual você vai trabalhar.
Neste módulo, você aprenderá a escolher nomes para suas variáveis que descrevem sua finalidade e intenção. Você aprenderá como adicionar comentários de código que documentam os requisitos de nível superior e sua abordagem no código, bem como instruir temporariamente o compilador a ignorar linhas de código. Por fim, ficará a saber como o espaço em branco pode ser utilizado para ajudar a transmitir a relação de linhas individuais de código.
No final deste módulo, escreverá código mais significativo, ao concentrar-se na legibilidade e na qualidade do código para comunicar com o compilador e com outros programadores.
Importante
Este módulo inclui atividades de codificação que exigem Visual Studio Code. Você precisará acessar 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, irá:
- Escolher um nome descritivo para as variáveis que descrevem a finalidade e a intenção.
- Utilizar comentários de código para instruir temporariamente o compilador a ignorar linhas de código.
- Utilizar comentários de código para descrever os requisitos de nível superior ou a finalidade de uma passagem de código.
- Escrever código que utilize efetivamente o espaço em branco para transmitir a relação de linhas de código.
Pré-requisitos
- Experiência usando o Visual Studio Code para criar e executar aplicativos de console C#.
- Experimente imprimir mensagens para o console usando
Console.WriteLine()o . - Experiência usando as
ifinstruções eelse ifpara criar ramificações de código.