PHP 주석, include/Include_once, Require/Require_once

댓글을 사용하는 이유는 무엇인가요?

• 한동안 소스 코드를 건드리지 않으면 코드가 무슨 역할을 하는지 잊어버리기 쉽습니다. 소스 코드에 주석을 달면 코드의 기능을 기억하는 데 도움이 됩니다.
• 여러 개발자가 동일한 프로젝트에서 작업해야 하는 경우 소스 코드에 주석을 다는 것도 매우 중요합니다. 한 개발자가 변경한 사항은 다른 개발자가 주석을 읽는 것만으로도 쉽게 이해할 수 있습니다.
• 모범 사례로, 코드 10줄당 3줄의 주석을 달아야 합니다.

PHP 댓글

• 주석은 코드를 이해하는 데 도움이 됩니다.
• 주석은 소스 코드에 포함된 설명입니다. 이 댓글은 인간의 이해를 위한 것입니다.
• 한 줄짜리 주석은 이중 슬래시(//)로 시작하고 같은 줄에서 끝납니다.
• 
• 여러 줄 주석은 슬래시와 별표 /*로 시작하고 별표와 슬래시 */로 끝납니다.
• 

아래 다이어그램은 여러 줄 주석과 한 줄 주석이 모두 포함된 PHP 파일을 보여줍니다.

PHP 예

PHP 포함 및 PHP 포함_한 번

PHP의 "include" 문은 다른 파일을 PHP 파일에 포함시키는 데 사용됩니다.

`include`와 `include_once` 두 가지 변형이 있습니다. `include_once`는 포함하려는 파일이 이미 포함된 경우 PHP 인터프리터에서 무시됩니다.

include 문의 구문은 다음과 같습니다.

<?php
include 'file_name';
?>

include_once 문의 구문은 다음과 같습니다.

<?php
include_once 'file_name';
?>

이리,

• “include/include_once”는 파일을 포함하는 구문입니다.
• "'file_name'"은 포함할 파일의 이름입니다.

예시: 포함 / 한 번 포함

당신이 개발자라고 가정해 봅시다.ping 모든 페이지에서 동일한 탐색 메뉴를 포함하는 웹사이트.

공통 헤더를 만든 다음, include 문을 사용하여 모든 페이지에 포함시킬 수 있습니다. 어떻게 하는지 살펴보겠습니다.

• 우리는 다음과 같은 이름의 파일 2개를 생성할 것입니다.
• 헤더.php, index.php

아래는 코드입니다. 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';

?>

위의 헤더 페이지에는 탐색 링크가 표시됩니다.

PHP 요구 및 PHP require_once

require 문에는 require와 require_once의 두 가지 변형이 있습니다.

`require`/`require_once` 문은 파일을 포함하는 데 사용됩니다.

require_once는 필요한 파일이 네 개의 include 문 중 하나라도 이미 추가한 경우 무시됩니다.

다음과 같은 구문을 갖습니다.

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

이리,

• "require/require_once"는 파일을 포함하는 구문입니다.
• "'file_name'"은 포함할 파일의 이름입니다.

예시: 필수

우리가 개발 중이라고 가정해 봅시다.ping 데이터베이스 기반 애플리케이션.

require 문을 사용하여 데이터베이스에 연결하는 모든 페이지에 포함할 수 있는 구성 파일을 생성할 수 있습니다. config.php

<?php

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

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

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

$config['password'] = '';

?>

이제 설정 파일이 필요한 예제 코드를 살펴보겠습니다. Pages_model.php

<?php

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

//other code for connecting to the database

?>

PHP 포함 및 필요

include와 require의 차이점은 아래와 같습니다.

일반적으로, 오류 발생 시에도 웹마스터 이메일 주소 또는 문의하기 페이지를 계속 표시하도록 include 문을 사용하는 것이 좋습니다.

요청된 파일 없이 전체 스크립트를 실행할 수 없는 경우 require 문을 사용해야 합니다.

"include" 및 "require" 문은 소스 코드에서 해당 코드가 나타나도록 하려는 어느 줄에서든 사용할 수 있습니다.

PHP 문서 주석(PHPDoc)

PHP 개발자는 단일 및 다중 행 주석 외에도 함수와 클래스를 문서화하기 위해 PHPDoc 블록 주석을 사용합니다. PHPDoc 블록은 /**로 시작하며 IDE가 힌트와 자동 완성 기능을 제공하는 데 사용하는 @param 및 @return과 같은 태그를 포함합니다.

<?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;
}
?>

PHPDoc은 코드 실행 방식을 변경하지 않지만, 각 함수의 의도를 명확히 하고 도구가 API 문서를 자동으로 생성할 수 있도록 합니다. 위에서 언급한 설정 파일 및 헬퍼 파일과 같은 공유 파일에 PHPDoc을 추가하면 규모가 커지는 코드베이스를 유지 관리하기 쉬워집니다.

자주 묻는 질문