백견이 불여일타/PHP

[php] 코드에 주석 추가하기

jhy_2023 2024. 7. 2. 22:32
728x90
반응형

<?php 
// 한줄 주석

# 한줄 주석

/* 
여러 
줄 
주석
*/

  /* 
  이 페이지는 멤버의 이름과
  현재 제안에 대한 세부 정보를 표시한다.
  */
  
?>
<!DOCTYPE html>
<html>

<head>
    <title>Adding Comments to Your Code</title>
    <link rel="stylesheet" href="css/styles.css">
</head>

<body>
    <h1>코드에 주석 추가하기</h1>
    <h2><?php echo 'Welcome Ivy'; // Show name ?></h2>
    <?php echo '<p class="offer">Offer: 20% off</p>' ?>
</body>

</html>
 

1. 한 줄 주석

한 줄 주석은 코드의 특정 줄에 대한 설명을 제공하며, 코드에 대한 간단한 메모나 설명을 추가할 때 사용됩니다. PHP에서는 한 줄 주석을 두 가지 방식으로 작성할 수 있습니다:

  • //를 사용하여 한 줄 주석을 작성합니다.
  • #을 사용하여 한 줄 주석을 작성할 수도 있습니다.

위 예제에서는 //와 #을 사용하여 각각 한 줄 주석을 작성하였습니다. 주석은 코드의 실행에 영향을 주지 않으며, 주석 뒤에 오는 텍스트는 PHP 인터프리터에 의해 무시됩니다.


2. 여러 줄 주석

여러 줄 주석은 긴 설명이나 여러 줄에 걸친 설명을 제공할 때 사용됩니다. 여러 줄 주석은 /*로 시작하여 */로 끝납니다. 주석 안에 있는 모든 텍스트는 주석으로 처리됩니다.

위 예제에서는 /*로 시작하고 */로 끝나는 여러 줄 주석을 사용하였습니다. 이 방법을 통해 여러 줄에 걸쳐 설명을 작성할 수 있습니다. PHP 코드 안에서 특정 블록이나 기능에 대한 자세한 설명을 제공할 때 유용합니다.


3. 주석은 브라우저로 전송되는 HTML에 추가되지 않는다

PHP 코드에 추가된 주석은 서버에서 처리되며, 클라이언트 브라우저로 전송되는 HTML 문서에는 포함되지 않습니다. PHP 스크립트는 서버에서 실행되고, 그 결과로 생성된 HTML만 브라우저에 전송되기 때문입니다.

<h2><?php echo 'Welcome Ivy'; // Show name ?></h2>
<?php echo '<p class="offer">Offer: 20% off</p>' ?>

위 예제에서는 <?php echo 'Welcome Ivy'; // Show name ?>와 같은 코드가 있습니다. 여기서 // Show name은 주석으로, PHP 코드 안에 있지만, 클라이언트에게 전송되는 HTML에는 포함되지 않습니다. 브라우저에 전송되는 HTML 코드는 다음과 같습니다:

<h2>Welcome Ivy</h2>
<p class="offer">Offer: 20% off</p>

결과적으로, 주석은 PHP 코드에서만 볼 수 있으며, 클라이언트가 주석 내용을 볼 수 없습니다. 이는 코드를 문서화하고, 개발자가 코드를 쉽게 이해할 수 있도록 돕지만, 클라이언트에게는 불필요한 정보가 전송되지 않도록 합니다.


 

해당 책을 참고하였습니다!

백엔드 프로그래밍을 위한 PHP & MySQL, 제이펍

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

728x90
반응형

'백견이 불여일타 > PHP' 카테고리의 다른 글

[php] 변수와 데이터 타입  (0) 2024.07.03
[php] 페이지에 콘텐츠 쓰기  (0) 2024.07.02