PHP | 주석 종류 정리

요약

주석(Comment)은 작성된 프로그램의 이해를 돕기 위해 추가하는 설명문입니다. 사람이 읽기 위해 존재하기 때문에 코드가 실행될 때는 무시됩니다.

PHP 주석 기본

// 한줄

가장 간단하게 사용할 수 있는 주석입니다

/*
여러 줄
*/

다른 줄까지 주석으로 묶습니다. VS Code의 경우 컨트롤 + / 을 입력하면 주석이 생성됩니다.

PHP 주석 심화

/**
* @brief 설명
* @author 작성자
* @since 생성 버전
* @param 매개변수 설명
* @return 반환 자료형 설명  
* @see 참고 주소 https://naver.com
* @version 1.0.0
* @todo 추가 작업
*/

공용 작업을 할 때는 서로가 약속된 방법으로 자료를 남기는 것이 좋습니다. 국내 뿐만 아니라 해외에서도 이 방법을 통해서 기록을 보관하는 편입니다.

/**
* 이건 짱짱 좋은 주석입니다
* 
* 주석은 협업할 때 중요한 기능을 가집니다. 짧고 간결하게 설명하는 것이 포인트입니다
* 이왕 하는거면 잘 정리하는 것이 좋아요 자세한 설명은 https://www.light-coding.com
*
* NOTE: 나는 빡빢이다
*
* @since 1.0
* @param bool $customer 
* @param int $food
* @return void
*/

매개변수는 위와 같이 나누어서 표현합니다.

자바스크립트 활용

/**
* 이름 나이를 출력하는 함수
* @param name 이름 넣어주세요
* @param {int} age 나이 입력해주세요
* @return 이름 나이 합쳐서 문자로 반환
*/
function sumNameAge() {
    return name + age;
}

sumNameAge('jeong' , '50');

자바스크립트는 위와 같이 사용할 수 있습니다.

활용

이제 함수에 컨트롤을 올리고 마우스를 클릭하면 위와 같이 예제 정보가 뜨게 됩니다