PHP 파일의 저자 및 프로젝트 이름을 올바르게 레이블 하시겠습니까?

Question

나는 단순히 자신의 신용을 가장 많이 받아들이고 전반적인 패키지를 문서의 시작 부분에서 설명하여 코드를 보는 다른 사람들이 참고할만한 것을 얻고 싶었다.

내가 일하고있는 PHP 프로젝트 때문에 대답을 알고 싶습니다. 사람들이 완료되면 사람들이 소스 코드를 볼 것입니다. 현재 처음에는 // 개의 댓글이 있지만 부족한 것처럼 보입니다. 사람들이 블록 주석을 사용하고 @author 등을 추가하는 것을 보았습니다. 이것이 허용되는 구문입니까?

감사합니다.

Answer 1

예, @author 및 @copyright과 같은 블록 주석 및 태그가있는 구문은 PHPDoc이라고 표준화되었습니다.

좋은 시작 참조 here을 찾을 수 있습니다.

코드 메타 데이터에 대해 표준화 된 마크 업 방법을 사용하면 큰 이점은 PHPDocumentor과 같은 표준화 된 도구를 사용하여 자동으로 설명서 like this을 생성 할 수 있다는 것입니다. 다른 하나는 PHPStorm과 같은 고급 IDE가 자동 완성 및 기타 코드 완성 기능을 제공하는 docblock을 구문 분석 할 수 있으며 스마트 리팩토링 도구까지도 포함 할 수 있습니다.

Answer 2

이 스타일은 PHPDoc 스타일로 사용할 수 있습니다.

/** 
* return string of content between provided 
* $from and $to positions. 
* if $to is not provided $from will be considered    
* a string to remove. 
* 
* @param string $str string from select contents 
* @param string $from starting point for select contents 
* @param string $to ending point for select contents * 
* @return string 
* @author 
*/ 
function extractor($str,$from,$to) 
{ 
    $from_pos = strpos($str,$from); 
    $from_pos = $from_pos + strlen($from); 
    $to_pos = strpos($str,$to,$from_pos);// to must be after from 
    $return = substr($str,$from_pos,$to_pos-$from_pos); 
    unset($str,$from,$to,$from_pos,$to_pos);   
    return $return; 

}