[PHP] 주석

PHP에서 주석은 코드에서 설명을 추가하고 코드의 동작을 이해하기 쉽게 만드는 데 사용됩니다. PHP에서는 주석을 세 가지 방법으로 작성할 수 있습니다.

 

1. 단일 행 주석

단일 행 주석은 코드 한 줄에 대한 설명을 추가할 때 사용됩니다. 주석은 //로 시작하며, // 다음에 오는 모든 내용은 주석으로 처리됩니다.

// 이것은 단일 행 주석입니다. 이 주석은 이 줄의 코드에 대한 설명을 추가합니다.
$variable = 42; // 변수에 값 42를 할당합니다.

 

2. 다중 행 주석

다중 행 주석은 여러 줄에 걸쳐 설명을 추가할 때 사용됩니다. 다중 행 주석은 /*로 시작하고 */로 끝납니다. /*와 */ 사이에 있는 모든 내용은 주석으로 처리됩니다.

/*
이것은
다중 행 주석입니다.
여러 줄에 걸친 설명을 추가할 때 유용합니다.
*/
$variable = "Hello"; // 변수에 문자열 "Hello"를 할당합니다.

 

3. 문서화 주석 (PHPDoc)

PHP에서는 코드의 문서화를 위해 특별한 주석 형식을 사용할 수 있습니다. 이를 PHPDoc 주석이라고 합니다. PHPDoc 주석은 함수, 클래스, 메서드 등에 대한 문서화 정보를 제공합니다. PHPDoc 주석은 함수나 메서드의 맨 위에 위치하며, /**로 시작하고 */로 끝납니다. 주석 내부에는 @로 시작하는 태그를 사용하여 추가 정보를 제공합니다.

/**
 * 이 함수는 두 정수를 더하여 결과를 반환합니다.
 *
 * @param int $a 첫 번째 정수
 * @param int $b 두 번째 정수
 * @return int 두 정수의 합
 */
function add($a, $b) {
    return $a + $b;
}

PHPDoc 주석은 다음과 같은 일반적인 태그를 사용할 수 있습니다.

 

- @param: 함수나 메서드의 매개변수에 대한 설명
- @return: 함수나 메서드의 반환 값에 대한 설명
- @var: 변수에 대한 설명
- @throws: 함수나 메서드가 던질 수 있는 예외에 대한 설명 등

 

주석은 코드를 이해하기 쉽게 만들어주며, 협업하는 개발자나 나중에 코드를 유지보수하는 개발자에게 큰 도움이 됩니다.

 

With ChatGPT