Contente
Um comentário é um tipo de nota que pode ser usado para explicar a finalidade e o significado de um trecho de código. Trabalhando em PHP, você terá várias opções para escrever comentários que vieram das antigas linguagens de programação conhecidas: inserindo comentários C de uma ou várias linhas. Você pode usar comentários para impedir que uma parte do código funcione ou apenas para manter registros.
Passos
Parte 1 de 2: Estilos
1 Comentários de linha única para postagens curtas. Se você precisar deixar um comentário curto, use o código de comentário de uma linha. O comentário se estenderá apenas ao final de uma linha ou ao final de um bloco de código. Esses comentários funcionam apenas com tags PHP e só serão lidos se colocados em HTML. ? php // Esta é a maneira padrão (C ++) de criar um comentário de uma única linha # Você também pode usar este estilo Unix para criar um comentário de uma única linha?> var13 ->
2 Use comentários de várias linhas para escrever comentários longos ou código de teste. Comentários multilinhas são muito úteis para escrever longas explicações e para evitar que um segmento de código seja processado. Leia a seção Uso para obter algumas dicas sobre como usar comentários multilinhas. ? php / * Veja como formatar um comentário de várias linhas. Todo o texto até o final da tag será incluído no comentário * / / * Algumas pessoas gostam de incluir * no início de cada linha * marcadores extras. Isso melhorará a * legibilidade de comentários grandes, embora não seja obrigatório. * /?> var13 ->
Parte 2 de 2: Usando
1 Use comentários para deixar notas sobre a integridade do código. Você não precisa fazer isso para cada linha de código, pois outros programadores podem facilmente descobrir um código bem escrito. Os comentários são úteis quando seu código está executando funções não padronizadas ou não óbvias. // Cria um pedido curl $ session = curl_init ($ request); // Diz ao curl para usar HTTP POST curl_setopt ($ session, CURLOPT_POST, true);
2 Deixe comentários para não esquecer o que fez com o código. Ao trabalhar em um projeto, os comentários evitarão que você se esqueça de onde parou. Deixe comentários para o código que não está funcionando corretamente ou que você ainda não concluiu. // Antes de passar para a próxima etapa, verifique novamente a saída deste programa echo "Hello World!";
3 Deixe um comentário para o código que você planeja compartilhar. Se você planeja colaborar com outros programadores ou vai tornar seu código publicamente disponível, os comentários ajudarão outras pessoas a entender como seu código funciona e o que precisa ser consertado. / * Existe uma maneira melhor de fazer isso? * / Gênero: input type = "radio" name = "gender"? Php if (isset ($ gender) && $ gender == "female") echo "verificado" ;?> value = "female"> Female input type = "radio" name = "gender"? php if (isset ($ gender) && $ gender == "male") echo "CHECK";?> value = "male "> Masculino
4 Deixe comentários para desfazer blocos específicos de código. Isso é muito útil quando você está testando seu código e deseja interromper a execução de uma parte dele. Qualquer coisa incluída na marca de comentário será ignorada quando a página iniciar. ? php echo "/ * Olá * / Mundo!"; / * Quando o código acima é executado, a palavra "Hello" não será refletida * /?> Var13 ->
5 Tenha cuidado ao comentar grandes blocos de código. A função de comentário terminará quando a primeira marca de conclusão estiver ativa, portanto, se houver um comentário de várias linhas dentro do código que você já comentou, ele durará apenas até o início do comentário original. ? php / * echo "Olá, mundo!"; / * Este comentário vai estragar tudo * / * /?> Var13 ->
? php / * echo "Olá, mundo!"; // Este comentário será adequado * /?> Var13 ->
6 Use comentários para criar pseudo gravações. Você pode usar alguns formatos de código criativo para criar uma entrada de código dentro dele. Isso é muito útil para projetos de código aberto. ? php // ============= // CABEÇALHO // ============== // ------------ - // Subtítulo // ------------- / * Nome da seção * / # As entradas podem ser escritas aqui # A segunda parte pode ser escrita aqui / * * Use isto para explicar * por que você precisaria de algumas linhas * ou mesmo de alguns pontos de explicação * /?> var13 ->
Pontas
- Os comentários de HTML e PHP são diferentes uns dos outros, portanto, ao trabalhar com scripts (uma combinação de HTML e PHP), certifique-se de usar a sintaxe correta.
- Por exemplo, o código a seguir contém um comentário HTML, mas ainda executa o código PHP. Se você colocar um comentário HTML dentro de uma tag PHP, isso resultará em um erro.
- ! - div id = "exemplo">? php echo ’hello’; ?> var13 -> / div> ->
