Uso de comentários no PHP

Uso de comentários no PHP
Os comentários são usados ​​com qualquer código -fonte para explicar a funcionalidade do código corretamente. Toda linguagem de programação usa uma sintaxe específica para adicionar um comentário no código -fonte. O comentário não é lido pelo intérprete ou compilador da linguagem de programação. O codificador realmente não precisa adicionar comentários no código, mas há dois benefícios de usar um comentário no código. Um benefício é tornar o código legível para que outras pessoas entendam o código corretamente, e outro benefício é ajudar o codificador a lembrar a funcionalidade do código após um longo tempo quando o código requer modificação. A sintaxe do comentário usada no PHP é semelhante a outras linguagens de programação padrão como C, C ++, Java, etc. O comentário pode ser uma linha única e multi-line. Como os comentários de linha única e de várias linhas podem ser usados ​​no código PHP são mostrados neste tutorial.

Comentário de linha única

Comentário de linha única pode ser usada no código PHP usando sintaxe diferente. Dois tipos do comentário de linha única do código PHP são mostrados neste tutorial. Um é a sintaxe do comentário c ++/java e outro é a sintaxe do comentário da shell. As duas sintaxes do uso de comentários de linha única no PHP são mostradas nesta seção do tutorial.

Exemplo 1: Comentários de linha única usando sintaxe C ++/Java

Os caracteres de hash duplo ('//') são usados ​​para comentar em uma única linha no script php. No script a seguir, os cinco comentários de linha única são usados ​​para explicar o código. Aqui, os valores de três cordas são declarados, e estes são combinados posteriormente em outra variável. Um comentário de linha única é adicionada para cada afirmação omitida pelo intérprete no momento da execução.

// Defina o primeiro valor da string
$ str1 = "Bem -vindo";
// Defina o valor da segunda sequência
$ str2 = "para";
// Defina o valor da terceira string
$ str3 = "linuxhint";
// Combine a corda com espaço
$ str = $ str1."".$ str2."".$ STR3;
// Imprima a corda combinada
eco "

$ str

";
?>

Saída:

A saída a seguir aparecerá após a execução do código. A saída mostra os valores combinados de $ str1, $ str2 e $ str3. Todos os comentários de linha única foram ignorados pelo intérprete.

Exemplo-2: Comentários de linha única usando sintaxe do shell

O símbolo '#' é usado para comentários de linha única no script shell que é suportado pelo PHP. O script PHP a seguir calcula se o ano atual for um ano bissexto ou não. A função personalizada isleap () é usada aqui para calcular se o ano atual é um ano bissexto ou não. O comentário de linha única é usada no código para tornar o script mais legível para os leitores. Aqui, a função date () é usada para ler o ano atual mencionado no comentário. Em seguida, a função mktime () é usada para verificar se o ano é um ano bissexto ou não. Se o ano for um ano bissexto, a função mktime () retornará 1 e o caractere de formato 'l' é usado na função DAT () para o ano bisseiro. Os comentários de linha única necessários são usados ​​no script.

#Leia o ano atual a partir da data do sistema
$ ano = data ("y");
#Call a função ISLEAP () e teste o valor de retorno
If (Isleap ($ ano))

eco "

O ano, $ ano é o ano bisseiro.

";

outro

eco "

O ano, $ ano não é um ano bisseiro.

";

#Define uma função para verificar o ano bissenhoso
Função Isleap ($ ano)

#Come o ano é salto ou não
return (data ('l', mktime (0, 0, 0, 1, 1, $ ano)) == 1);

?>

Saída:

A saída a seguir aparecerá após a execução do código. A saída mostra que o ano atual, 2020, é um ano bissexto, e todos os comentários de linha única foram ignorados pelo intérprete.

Comentário de várias linhas

Um comentário de várias linhas é usado para adicionar um comentário de texto longo. Se o codificador precisar explicar a função do código em detalhes para melhor entender, ele poderá adicionar um comentário de várias linhas para esse código. O '/*' é usado no início do comentário e '*/' é usado no final do comentário. Esse tipo de comentário de várias linhas é usado em qualquer linguagem de programação padrão, como Java, C ++, etc. Um comentário de várias linhas é usado principalmente no início de qualquer script para fornecer informações detalhadas sobre o script, scriptwriter, versão, link do código-fonte, etc.
Como os comentários de várias linhas são usados ​​no PHP é mostrado no exemplo a seguir:

Exemplo 3: Comentário de várias linhas usando '/ *… */'

No script a seguir, três comentários de várias linhas são usados ​​para explicar o código. O primeiro comentário descreve a funcionalidade do script. O segundo comentário explica a função da função rand (). O terceiro comentário explica o objetivo da função iSPrime (). Um número aleatório entre 1 a 100 será gerado toda vez que o script é executado, e a função ISPrime () descobrirá se o número é primo ou não. Se a função retornar true, o número será primordial. Caso contrário, o número não é primitivo.

/* O script a seguir testará um número específico
Prime ou não, Prime usando uma função personalizada
*/
/* Atribua um número aleatório entre 1 a 100 usando
Função PHP integrada Rand ()
*/
$ número = rand (1.100);
// verifique se o número é primo ou não primo
if (iSPrime ($ número))
eco "

Número de $ é um número primo.

";
outro
eco "

Número de $ não é um número primo.

";
/* A função retornará 1 se o número aleatório gerado
Número aleatório é primo e retorne 0 se o número não for
melhor */
função isprime ($ número)
if ($ número == 1)
retornar 0;
para ($ i = 2; $ i

Saída:

A saída do script variará em todas as execuções por causa do número aleatório. A saída a seguir apareceu após a execução do código pela primeira vez e será alterada na próxima execução. Se o número aleatório gerado for prime, o ISPrime () retornará 1 e se o número aleatório gerado não for o Prime, então o ISPrime () retornará 0.

Conclusão

Todo script padrão contém comentários para ajudar o leitor a entender o código corretamente. Muitos novos codificadores não adicionam comentários em seu script que dificultam o código para outros codificadores. Então, quando você escreve qualquer script, adicione comentários para cada declaração.