4 - Identação e Comentários em C#

  Todo bom texto deve ter uma boa formatação. Imagine se comprássemos um livro que viesse sem parágrafos, margens e tabulações, ou para piorar, que fosse utilizada somente uma única linha para escrevê-los ! Ler já não é o esporte preferido da maioria das pessoas, se fosse desse modo seriam raros os leitores pelo mundo e mais raros ainda os que conseguiriam entender a contextualidade do livro :-) .
  Em qualquer linguagem de programação (e não somente C#) é necessário uma organização semelhante para facilitar a escrita, interpretação e correção do código programado. Esta organização do código é denominada Identação.
  Analizando um código simples poderiamos obter umas situação assim:

using System;namespace meuprograma{class programa1{static void Main(){Console.WriteLine("Ensopado de TI !");}}}

   E acreditem ! Esse código não apresentaria erros !
   Como citado em tutoriais anteriores, um dos erros mais comuns na hora de compilar um programa, é a questão de abertura e fechamento das chaves, sem a identação com certeza estes erros seriam mais frequentes e a escrita do código muito mais tortuosa!
   Então vejamos o codigo a seguir :

using System;
namespace meuprograma
{
class programa1
{
static void Main()
{
Console.WriteLine("Ensopado de TI !");
}
}
}

 Opa ! A leitura desse código já pode ser promovida de horrível para razoável !
Mesmo controlando a  estrutura por linhas, ainda não fica muito clara a noção de hierarquia de execução e
qual das chaves abre quem ou fecha oquê. Vejamos abaixo como esse código ainda pode evoluir !

using System;

namespace meuprograma
{
 |     class programa1
 |          {
 |           |      static void Main()
 |           |      {
 |           |       |   Console.WriteLine("Ensopado de TI !");
 |           |      }
 |          }
}

 No caso, nosso compilador não deixará noso código colorido :-). Mas as cores são somente para notar melhor a estrutura dos espaçamentos e das chaves.
 Fica claro que a 1ª chave (rosa) está abrindo "{" para a classe ("programa1"), a 2ª chave (verde) abre para  (static void Main) e a 3ª chave (azul) para ("Console.WriteLine"). Como tudo na Vida precisa ter um começo e um fim , precisamos encerrar o que começamos e de forma alinhada fechamos cada chave aberta com seu par !
 Abrimos 3 chaves e fechamos 3 e desse modo estruturado com toda certeza fica muito mais claro a interpretação do código :-).

 Inserindo Comentários em C#.

   Está é uma dica simples mas poderosa dentro das linguagens de programação !!!
Os comentários são textos que podem ser escritos junto com o código sem serem interpretados pelo compilador, ficando ocultos quando o programa final é executado e podendo ser lidos apenas no código fonte. Eles podem ter diversas funções como:

• Lembrar o programador a utilidade de certa parte do código.
• Inserir informações a respeito da escrita do código ( data, versão, criação, alteração, autor)
• Documentar os processos no código para outro programador.
• etc...

 Os comentários podem ser de dois tipos.
  
    1- Comentários de apenas uma linha que utilizam o "// " Exemplo:

// Programa criado em 26/08/2009 por Rodrigo Ribeiro C. Barbosa.
using System;

namespace meuprograma
{
         class programa1
         {
               static void Main() // Aqui é o ponto de partida !
                     {
                              Console.WriteLine("Ensopado de TI !"); 
                     }
         }
}
// Versão do programa: 4.844.45.7.7888.9.Beta RC31 :-)


      Todo o texto que seguir após as barras  "//"  será ignorado pelo compilador . Simples não?

  2- Agora imagine que você seja uma pessoa que goste de detalhar um pouco mais e não se conforme em comentar em apenas uma linha (principalmente as mulheres!), seria um tanto quanto chato escrever as barras no começo de cada linha, então pensando em vocês foi criado o recurso "/*" para abrir o comentário e "*/" para fechá-lo! Vejamos um exemplo:

using System;
namespace meuprograma
{
         class programa1
             {
                   static void Main()
                       {
                              Console.WriteLine("Ensopado de TI !");
                             /* blá blá blá blá blá blá blá blá blá blá blá 
                                 blá blá blá blá blá blá blá blá blá blá blá 
                                 blá blá blá blá blá blá blá blá blá blá blá 
                                 blá blá blá blá blá blá blá blá blá blá blá */
                       }
             }
}



 Todo este nosso Blá blá blá não será interpretado pelo compilador e precisaremos apenas usar o recurso de abertura "/*" e fechamento "*/" para escrever nosso extenso comentário.

 Até mais!