Comentários PHP

Resumo : neste tutorial, você aprenderá como usar comentários PHP para documentar seu código.

Os comentários são partes importantes do código. Os comentários fornecem informações úteis que ajudarão você e outros desenvolvedores a entender o significado do código mais rapidamente posteriormente.

PHP suporta dois tipos de comentários:

• Comentários de uma linha
• Comentários de várias linhas

Comentários de uma linha

O comentário de uma linha é colocado no final da linha ou no bloco atual.

Um comentário de uma linha começa com um sinal de cerquilha ( #) ou uma barra dupla ( //). O restante do texto após (//) é ignorado pelo interpretador PHP.

O exemplo a seguir usa // para um comentário de uma linha:

<?php

$rate = 100;
$hours = 173;
$payout = $hours * $rate; // payout calculationLinguagem de código:  HTML, XML  ( xml )

E o exemplo a seguir usa # para um comentário de uma linha:

<?php

$title = 'PHP comment'; # set default titleLinguagem de código:  HTML, XML  ( xml )

Comentários de várias linhas

Um comentário de várias linhas começa /* e termina com */. Por exemplo:

<?php
/*
   This is an example of a multi-line comment,
   which can span multiple lines.
*/Linguagem de código:  HTML, XML  ( xml )

Na prática, você usa o comentário de várias linhas quando precisa abranger comentários em várias linhas.

Escrevendo comentários significativos

Para documentar seu código de forma eficaz, você usa as seguintes diretrizes:

1) Fazer o código falar por si sem usar comentários, nomeando identificadores significativos. Por exemplo, você pode usar o seguinte:

$is_completed = true;Linguagem de código:  PHP  ( php )

Em vez de usar um nome enigmático com um comentário:

$ic = true; // is completedLinguagem de código:  PHP  ( php )

O código em si pode ser um bom comentário.

2) Não escreva um comentário para explicar o que o código faz; em vez disso, explique por que ele faz isso. Por exemplo:

// complete the task
$is_completed = trueLinguagem de código:  PHP  ( php )

3) Ao escrever um comentário, seja o mais conciso possível.

Resumo

• Os comentários são partes importantes do código porque explicam por que o código faz o que deveria fazer.
• PHP suporta comentários de uma linha e de várias linhas.
• Um comentário de uma linha começa com #ou // .
• Um comentário de várias linhas começa /*e termina com */.