Abrindo as fontes do projeto inicial me deparei com dois tipo de comentários com // e /// qual a diferença entre os dois e quando usar?
Abrindo as fontes do projeto inicial me deparei com dois tipo de comentários com // e /// qual a diferença entre os dois e quando usar?
Olá, Jose!
As barras duplas (//) é a forma padrão de escrever um comentário de uma única linha. Comentários escritos com // são usados para adicionar notas ou explicações breves em seu código.
As barras triplas (///) é um tipo de comentário conhecido como "comentário de documentação". Utilizado para documentar o código, e podem ser lidos por ferramentas de documentação, como o DartDoc.
Eles geralmente são usados para descrever a finalidade de uma função, classe, método, variável, etc... Fornecendo informações mais detalhadas ao código.
Ex:
/// Esta é uma função de exemplo para praticar comentários no Alura.
///
/// Ela recebe dois parâmetros, e realiza uma
/// operação específica com eles.
///
/// Retorna o resultado da operação.
int funcaoAlura(int parametro1, int parametro2) {
// Código da função
return parametro1 + parametro2;
}
Espero ter sanado sua dúvida! Abraço!