[php] 주석 표기하는 방법

[php] 주석 표기하는 방법

 

 

php 에서

 

여러명과 함께 작업하는 경우

 

혹은 다음 작업자를 위해 설명을 달아놓는경우

 

기능별 함수마다 

 

함수명 위에 아래와 같은 주석을 달아서 공유하고는 합니다.

/**
* @brief 설명
* @author 작성자
* @param 파라미터 설명
* @return 리턴값 설명
* @todo 남은작업 혹은 해야하는 작업
*/

 

위 내용 보시면 아시겠지만,

 

설명, 작업자, 변수, 반환값, 남은 작업 과 같은 내용들이 보통 기재하는 내용이라고 보시면 되구요.

 

추가적으로 시간이나 버전이 필요하면,

 

작업내용에 따라 표기하면 됩니다!

 

보통 이렇게 한다는거고! 정해져 있는 내용은 없습니다!

 

작업자들간에 내용 공유가 최우선이니 전달만 잘되면 되는듯 합니다!

 

참고들 하세요!