Comentários em PHP
Em PHP, você pode adicionar observações ou comentários ao seu código de várias maneiras...
Comentários de Linha Única
Você pode usar // ou # para adicionar comentários que ocupam apenas uma linha.
// Este é um comentário de linha única
# Este também é um comentário de linha única
echo "Olá, mundo!"; // Este comentário está ao lado de um código
Comentários de Múltiplas Linhas
Para comentários que ocupam várias linhas, você pode usar /* comentário */.
/*
Este é um comentário
que ocupa várias linhas.
*/
echo "Olá, mundo!";
Comentários em DocBlocks
Os DocBlocks são utilizados para documentar funções, classes ou métodos...
/**
* Soma dois números.
*
* int $a O primeiro número.
* int $b O segundo número.
* int A soma dos dois números.
*/
function somar($a, $b) {
return $a + $b;
}
Boas Práticas
- Seja Claro e Conciso: Tente explicar o que o código faz...
- Atualize os Comentários: Sempre mantenha os comentários atualizados...
- Evite Comentários Óbvios: Comentários que repetem o óbvio devem ser evitados.
Dicas e Mais Boas Práticas
- Comentários de código de debug: Não deixe em produção.
- TODOs: Marque melhorias com
// TODO: - Documentação de API: Use DocBlocks para documentar funções.