Comentários PHP, Incluir/Incluir_once, Exigir/Exigir_once

Por que usar comentários?

• Se você não trabalhar no código-fonte por algum tempo, é fácil esquecer o que ele faz. Comentar o código-fonte ajuda a lembrar o que ele faz.
• Comentar o código-fonte também é muito importante quando vários desenvolvedores precisam trabalhar no mesmo projeto. As alterações feitas por um desenvolvedor podem ser facilmente compreendidas por outros desenvolvedores simplesmente lendo os comentários.
• Como boa prática, você deve ter 3 linhas de comentários para cada 10 linhas de código.

Comentários PHP

• Os comentários nos ajudam a entender o código
• Comentários são explicações que incluímos em nosso código-fonte. Esses comentários são para compreensão humana.
• Comentários de uma única linha começam com duas barras invertidas // e terminam na mesma linha.
• 
• Comentários de várias linhas começam com uma barra seguida pelo asterisco /* e terminam com o asterisco seguido pela barra */.
• 

O diagrama abaixo mostra um arquivo PHP com comentários de várias linhas e comentários de linha única.

Exemplo de PHP

PHP Incluir e PHP Incluir_once

A instrução "include" do PHP é usada para incluir outros arquivos em um arquivo PHP.

Possui duas variações: `include` e `include_once`. `include_once` é ignorado pelo interpretador PHP se o arquivo a ser incluído já tiver sido incluído.

A instrução include tem a seguinte sintaxe

<?php
include 'file_name';
?>

A instrução include_once tem a seguinte sintaxe

<?php
include_once 'file_name';
?>

AQUI,

• “include/include_once” é a declaração que inclui o arquivo.
• “'file_name'” é o nome do arquivo a ser incluído.

Exemplo: Incluir / Incluir_uma_vez

Suponha que você esteja desenvolvendoping Um site que contém o mesmo menu de navegação em todas as páginas.

Você pode criar um cabeçalho comum e, em seguida, incluí-lo em todas as páginas usando a instrução `include`. Vejamos como isso pode ser feito.

• Criaremos 2 arquivos chamados
• cabeçalho.php, index.php

Abaixo está o código para header.php

<a href="index.php">Home</a>

<a href="aboutus.php">About us</a>

<a href="services.php">Services</a>

<a href="contactus.php">Contact Us</a>

index.php

<?php

include 'header.php';

?>

A página de cabeçalho acima exibirá os links de navegação.

PHP requer e PHP require_once

A instrução require tem duas variações, require e require_once.

A instrução `require/require_once` é usada para incluir um arquivo.

O parâmetro `require_once` é ignorado se o arquivo necessário já tiver sido adicionado por alguma das quatro instruções `include`.

Possui a seguinte sintaxe

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

AQUI,

• “require/require_once” é a declaração que inclui o arquivo.
• “'file_name'” é o nome do arquivo a ser incluído.

Exemplo: Requerer

Suponha que estamos desenvolvendoping Um aplicativo baseado em banco de dados.

Podemos criar um arquivo de configuração que podemos incluir em todas as páginas que se conectam ao banco de dados usando a instrução require. config.php

<?php

$config['host'] = 'localhost';

$config['db'] = 'my_database';

$config['uid'] = 'root';

$config['password'] = '';

?>

Vejamos agora o código de exemplo que requer o arquivo de configuração. Páginas_model.php

<?php

require 'config.php'; //require the config file

//other code for connecting to the database

?>

PHP inclui vs exige

A diferença entre incluir e exigir é mostrada abaixo.

Em geral, recomenda-se o uso da instrução `include` para que, quando ocorrer um erro, a execução do script continue exibindo o endereço de e-mail do webmaster ou a página de contato.

A instrução require deve ser usada se o script inteiro não puder ser executado sem o arquivo solicitado.

As instruções “include” e “require” podem ser usadas em qualquer linha do código-fonte onde você deseja que o código apareça.

Comentários da documentação do PHP (PHPDoc)

Além de comentários de uma ou várias linhas, os desenvolvedores PHP usam blocos de comentários PHPDoc para documentar funções e classes. Um bloco PHPDoc começa com /** e usa tags como @param e @return que as IDEs leem para mostrar dicas e autocompletar.

<?php
/**
 * Adds two numbers together.
 *
 * @param int $a The first number
 * @param int $b The second number
 * @return int The sum of the two numbers
 */
function add($a, $b) {
    return $a + $b;
}
?>

O PHPDoc não altera a forma como o código é executado, mas torna a intenção de cada função clara e permite que as ferramentas gerem documentação de API automaticamente. Adicioná-lo a arquivos compartilhados, como os arquivos de configuração e auxiliares mencionados acima, mantém uma base de código crescente organizada e fácil de manter.

Perguntas Frequentes