3
오늘 처음으로 PHPDoc을 사용해 보았는데 문제가 발생했습니다.PHPDoc 자세한 표시는 가치가 있습니까?
변수 선언 1 줄마다 적어도 5 줄의 주석이있었습니다. 예 :
/**
* Holds path the remote server
* @name ...
* @global ...
*/
$myvar = ...
물론 이점은 좋지만 10 줄 구성 파일이 60 줄 파일로 바뀝니다. 필자는 영원히 채워 넣었고, 나는 그것이 단순한 한 줄짜리 이상으로 많은 것을 추가한다고 확신하지는 못했다.
또한 워크 플로에 꼬임이 생깁니다. 전반적인 변경이 필요할 때까지는 모두 훌륭합니다. 잘 문서화 된 doc 블록을 사용하여 갑자기 더 이상 내 코드를 리팩터링 할 필요가 없지만 이러한 지루한 세부 정보를 모두 다시 작성해야합니다. 네가 끝날 때까지 기다려? HAH! 그렇다면 문서화는 결코 일어나지 않을 것입니다.
그 중에서도 코드의 중간에있는 C 스타일/**/주석이 필요합니다. 수요가 커지면 커다란 블록을 주석 처리 할 수 없으므로 개발 과정에서 미친 듯이 날아 가게됩니다. 이제 큰 코드 블록을 주석 처리하려면 range, s/^/# /; 나중에 실행 취소하십시오. 성가신!
짧은 이야기 - 필자는 PHPDoc을 좋아하지만 잘 문서화 된 코드를 좋아하지만 한 줄의 코드 당 5 줄의 주석은 너무 많습니다! !. 누락 된 기능이 있습니까? 이것은 일반적인 문제입니까?