COMENTÁRIOS EM C#

COMENTÁRIOS

Comentário é qualquer texto contido dentro do nosso código que será ignorado pelo compilador. Trabalhar com comentários é uma prática comum pelos desenvolvedores. O objetivo é poder adicionar descrições em partes especificas de código para documentar funcionalides, módulos, ou então, para descrever qualquer outra informação necessaria e relevante.

Os comentários, utilizam um notação especial para se diferenciar do código propriamente dito. Há 2 formas para trabalharmos com comentários. Comentário de uma única linha, comentário em várias linhas.

//o que estiver a frente barra-barra é ignorado

NOTAÇÃO MULTILINES (VÁRIAS LINHAS)

O uso de /**/ define comentários de várias linhas. Tudo que estiver entre /* e o */ será ignorado pelo interpretador, indifente de quantas linhas existirem, tudo que estiver delimitado por essa notação, é automaticamente ignorado.

/*
    esse aqui
    é um comentário
    de várias linhas
*/

PARA QUE UTILIZAMOS COMENTÁRIOS?

A utilização de comentários pode ser tanto para a inserção de alguma informações que não pode ser esquecida, ou então, algo que desejamos que outros programadores saibam no momento em que estiverem lendo o código.

A primeira utilização dos comentário é fazer o que o próprio nome sugere: comentar os nosso códigos, informando assim, ao interpretador, que essas linhas não devem ser executadas.

DOCUMENTAÇÃO DE PROGRAMAS

Utilizamos a marcação de comentários para documentarmos programas, classes, funções, variáveis, constantes ou seja lá o que for. Quando criamos uma biblioteca e essa será utilizada por terceiros, é importante que o código possua uma documentação para que os outros programadores entendam a nossa biblioteca e saibam como invocar as funções corretamente. É comum que haja informações para o fácil entendimento da lógica que foi utilizada ou entao, para descrever a razão pela qual foi implementado desta forma e nao de algum aoutra.

Quando documentamos partes internas do nosso programa, temos que, ao mesmo tempo em que documentamos o que estamos fazendo, também geramos documentação que será, posteriormente extraída nosso código e então, a mesma, será utilizada, na documentação propriamente dita. Dessa forma, conseguimos manter o codigo e a sua documentação num mesmo arquivo.

É recomendável se acostumar a documentar o código! Isso não somente faz de nós melhores programadores como também, ajuda-nos na definição para nós mesmo da existência de cada parte e módulo do programa.

EXEMPLO FEITO EM AULA

A seguir, temos o exemplo feito na vídeo aulas sobre a utilização de comentários.

using System;

namespace Aula
{
    class Program
    {
        /**/

        static void Main(string[] args)
        {
            //Isso aqui é um comentário
        }
    }
}