Comentários em PHP

Os comentários do PHP são normalmente apresentados a nós de forma a satisfazer nossas necessidades acadêmicas e práticas.



Comentários do PHP

No código PHP , um comentário é uma linha que não faz parte do programa. Isso ocorre porque os comentários do PHP são projetados para não aparecer na saída do programa.

Resumindo, ele foi projetado apenas para ser lido por uma pessoa que está olhando o código e não tem outra finalidade.

Você pode usar comentários para os seguintes propósitos:

  • O código que você escreve deve ser compreensível por outros desenvolvedores.
  • Mantenha-se familiarizado com o que você fez– Muitos programadores tiveram a experiência de voltar a alguns dos trabalhos que fizeram alguns meses ou anos depois e reaprender do zero o que fizeram.
  • Você pode usar o comentário em PHP para se lembrar do que estava pensando ao escrever o código em primeiro lugar.

Em PHP , os comentários podem ser suportados de várias maneiras diferentes, como as seguintes:

No caso de comentários de linha única , a sintaxe é a seguinte quando se trata de comentar em PHP :

Example: 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<!DOCTYPE html>
<html>
<body>
<?php
// Slashes use as single-line comment
# Hashtag can also use for single-line comment
?>
</body>
</html>
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Example: 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<!DOCTYPE html>
<html>
<body>
<?php
// To comment single-line
# Also use for commenting single-line
?>
</body>
</html>
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

No caso de comentários de várias linhas , a sintaxe é a seguinte:

Example: 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<!DOCTYPE html>
<html>
<body>
<?php
/*
A multi-line comment block spans across multiple lines of text.
This comment block is made up of a number of lines of text
*/
?>
</body>
</html>
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Example: 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<!DOCTYPE html>
<html>
<body>
<?php
/*
Comment blocks that span multiple
lines of text are called multi-line comment blocks.
*/
?>
</body>
</html>
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Os exemplos a seguir mostram como usar comentários para remover partes do código:

Example: 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!DOCTYPE html>
<html>
<body>
<?php
// You can use comments to remove parts of code line
$a = 6 /* + 2 */ + 4;
echo $a;
?>
</body>
</html>
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Example: 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!DOCTYPE html>
<html>
<body>
<?php
// Commenting is also a useful way to leave out certain parts of a code line when writing it
$a = 7 /* + 8 */ + 3;
echo $a;
?>
</body>
</html>
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Vantagens dos Comentários Php:

  • Legibilidade de código aprimorada: o objetivo dos comentários é ajudar outras pessoas (e você mesmo) a entender o código no futuro, explicando partes específicas dele.
  • Depuração: Para fins de depuração , os comentários também podem servir como lembretes ou notas.
  • Colaboração: seu código pode ser melhor compreendido por outras pessoas quando você deixa comentários em uma equipe.
  • Manutenção: A manutenção e atualizações do código podem ser facilitadas com comentários.

Comentários Php Desvantagens:

  • Tamanho de arquivo aumentado: se os comentários não forem gerenciados adequadamente, eles podem aumentar o tamanho do arquivo de código e tornar o site lento.
  • Carga de manutenção: pode ser enganoso e confuso se os comentários não forem atualizados quando o código for alterado.
  • Comentários excessivos: é difícil entender rapidamente um código com muitos comentários.
  • Segurança: o código disponível publicamente pode incluir informações confidenciais, como credenciais de banco de dados ou chaves de API, que podem representar um risco de segurança. Certifique-se de que todas as informações confidenciais sejam removidas dos comentários.
Nós valorizamos o seu feedback.
+1
0
+1
0
+1
0
+1
0
+1
0
+1
0
+1
0

Assine a nossa newsletter
Digite seu e-mail para receber um resumo semanal de nossos melhores posts. Saber mais!
ícone