[모던 PHP] 24.01. PHPDOC 으로 코드 문서화하기

안녕하세요 모피핸입니다.
모던 PHP 핸드북 챕터 24.01. PHPDOC 으로 코드 문서화하기를 알아봅니다.

---

PHPDOC 은 PHP 코드를 문서화시키는 사실상의 표준입니다. 대부분의 IDE는 PHPDOC의 형식을 읽고 IDE에 표시할 수 있습니다.

<?php  
/**  
 * @author mopihan  
 * @link http://www.phpdoc.org/docs/latest/index.html  
 */  
class ModernPhpHandbook  
{  
    /**  
     * @param mixed $anything \int 책 ID  
     *  
     * @throws \BookNotFoundException  
     *  
     * @return \Book  
     */  
    public function read($id)  
    {  
        $book = getBook($anything);  



        if ($book){  
            return $book;  
        }  



        throw new \BookNotFoundException(  
            "Book is not exist."  
        );  
    }  
}  

클래스 선언 위에는 @author 와 @link 태그를 쓸 수 있습니다. 각각 저자와 링크를 나타냅니다.
각 메소드에는 매개변수를 나타내는 @param, 던질 수 있는 예외인 @throws, 그리고 리턴 타입을 나타내는 @return 태그가 보입니다. 만일 리턴 타입이 없다면 생략하거나 void 로 기재하는 것도 가능합니다.

PHPDOC에 대한 자세한 태그의 설명은 https://docs.phpdoc.org/latest/index.html 에서 볼 수 있습니다.

---

모던 PHP 핸드북에 대해 궁금하신 분은 모던 PHP 핸드북 소개 를 참고하세요.