[PHP] PhpStorm DocBlock 자동 완성

[업데이트 2016.11.23 14:59]

인라인 문서화를 위해 PHP 코드에 주석을 다는 것은 코드 가독성 등의 측면에서 필요한 작업인데, PhpStorm에서 이러한 Doc Block 완성을 자동으로 쉽게 해주는 기능이 있습니다.

** DocBlock 발췌: https://phpdoc.org/docs/latest/glossary.html#term-docblock
** PhpStorm DocBlock 발췌: https://www.jetbrains.com/help/phpstorm/2016.2/creating-php-documentation-comments.html

다음과 같이 Alt+Insert를 누른 후, PHPDoc Blocks...를 선택합니다.

다음과 같이 namespace부터 class, class member variable/function 모두를 선택 후, ok를 클릭합니다.

다음과 같이 자동으로 Doc Block 템플릿이 완성 되었습니다.

또한 파일별로 copyright을 지정할 수 있는데, 다음과 같이 매뉴 > Settings > Editor > Copyright > Copyright Profiles에서 원하는 copyright 문구를 추가합니다. 그리고 Alt+Insert를 통해 주석 추가시 Copyright을 선택하여 추가합니다. 아래와 같이 copyright이 자동으로 추가됨을 확인 할 수 있습니다.

이제 필요한 내용을 업데이트하면 됩니다. GitHub와 같이 Open Source로 프로젝트를 진행 할 때, 사용방법에 대한 문서화뿐만 아니라 코드 내부 문서화도 필수인데, PhpStorm 내부에서 제공하는 Doc Block 자동 완성 기능이 많이 유용할 것 같습니다.