Adicionar comentários em PHP: 7 etapas (com fotos)

Contente

Degraus
- Parte 1 de 2: Estilos
- Parte 2 de 2: Uso
Pontas

Comentários dentro de uma linguagem de programação são certas notas que podem ser usadas para esclarecer o propósito e a intenção de um bloco de código. Ao usar o PHP, você tem várias opções para escolher que derivam de linguagens de programação mais antigas e amplamente usadas, com duas opções quando se trata de comentários de linha única e também um formulário de comentário de várias linhas, derivado do estilo usado no C linguagem de programação. Você pode usar comentários para impedir a execução de blocos de código e pode até usá-los para gerar documentação.

Degraus

Parte 1 de 2: Estilos

1. Use comentários de uma linha para comentários curtos. Se você quiser postar um comentário curto, você pode usar o código de uma linha para isso. Este comentário não vai além do final da linha ou do final do bloco de código. Este tipo de comentário só funciona dentro de tags PHP e será lido se colocado dentro do código HTML.

1. Use comentários de várias linhas para comentários mais extensos ou testes de código. Comentários de várias linhas são úteis para escrever uma explicação mais longa ou para impedir a execução de um determinado segmento de código. Leia a parte "Uso" abaixo para algumas dicas sobre como usar comentários de várias linhas.

Parte 2 de 2: Uso

1. Use comentários para deixar comentários sobre como o código funciona. Não há necessidade de fazer isso para cada linha de código, pois o código bem escrito é fácil para outros programadores entenderem. É útil se houver funções incomuns ou pouco claras no código.

// Gera solicitação de curl $session = curl_init($request); // Diz ao curl para usar HTTP POST curl_setopt ($session, CURLOPT_POST, true);

Deixe um comentário para não esquecer o que fez. Ao trabalhar em seus próprios projetos, os comentários podem ajudá-lo a lembrar de onde parou. Comente sobre o código que não funciona ou que você ainda não concluiu.

// Tem que ver isso antes de continuar echo "Olá Mundo!";

Comente o código que você deseja compartilhar. Se você planeja colaborar com outras pessoas ou deseja tornar o código de código aberto, os comentários podem ajudar outras pessoas a descobrir o que seus recursos fazem e onde eles podem melhorar.

/* Existe uma maneira mais eficaz de fazer isso? */ Sexo:

Use comentários para evitar que determinados blocos de código sejam executados. Isso é útil se você quiser testar algo e impedir que determinado código seja executado. Tudo dentro das tags de comentário será ignorado durante o carregamento da página da web.

2. Tenha cuidado ao comentar em grandes blocos de código. A função de comentário parará quando a primeira tag final for sinalizada, portanto, se já houver um comentário de várias linhas no código que você deseja comentar, esse comentário será interrompido no final do comentário aninhado.

3. Use comentários para criar pseudodocumentação. Você pode usar alguma formatação criativa para criar documentação para seu código diretamente no código. Isso pode ser útil para projetos de código aberto.

Pontas

Comentários HTML e comentários PHP são diferentes uns dos outros, portanto, se você estiver usando scripts (uma mistura de HTML e PHP), tome cuidado para não confundir os códigos de comentários.
Por exemplo, no código abaixo, tem comentários HTML, mas o código PHP ainda é executado. Colocar comentários HTML dentro de tags PHP causará erros.