phpdoc 내 보 내기 문서 에서@package 의 warning 및 Error 오 류 를 완벽 하 게 해결 합 니 다.

오늘 PHPDoc 내 보 내기 문 서 를 작성 할 때 답답 한 오 류 를 발 견 했 습 니 다.이 warning 은 중요 한 오 류 는 아니 지만 항상 불쾌 합 니 다.그래서 인터넷 에서 관련 자 료 를 많이 찾 았 습 니 다.그런데 답답 한 것 은 제 가 사용 하 는 PHPDoc 버 전이 너무 새 롭 습 니 다(1.4 버 전).아니면 많은 사람들 이 이 문 제 를 겪 지 않 았 습 니 다.어차피 관련 자 료 를 찾 지 못 했 습 니 다.PHPDocumentor 공식 네트워크 에서 쏟 아 낸@package 에 관 한 주의사항 을 찾 았 을 뿐 한 가지 만 검사 할 수 있 습 니 다.버 전 하나 또 버 전 을 보고 드디어 내 가 해결 했다.
그리고 이 방안 이@package 와 관련 된 오류 알림 을 해결 할 수 있 음 을 발 견 했 습 니 다.
문제 발생:
1、no @package tag was used in a DocBlock for XXXXXXXXXXX
2、XXXXXX has no page-level DocBlock, use @package in the first DocBlock to create one
3、ERROR： XXXX can not have @package tag。。。。（구체 적 인 힌트 는 잊 어 버 렸 습 니 다.큰 문 제 는 여기 문서 에서@package 라벨 을 사용 할 수 없다 는 뜻 입 니 다)
상소 문제 가 발생 한 주요 원인 은 페이지 급 문서 블록 주석 해석 오류 입 니 다.
페이지 급 문서 설명:
파일 의 첫 번 째 문서 블록 주석 이 어야 하 며@package 태그 가 있어 야 합 니 다.
이 문 서 는 설명 이 빠 른 후에 PHP 코드 나 class 클래스 에 이 어 설명 이 있 으 면 문서 블록 주석 으로 분리 해 야 합 니 다.(즉,페이지 급 문서 블록 주석 이후 코드 세 션 에 이 어 서 는 안 됩 니 다)
예 를 들 어 상황:

   ：  
 
/** 
 *               
 *@package haha 
 * 
 */ 
class test { 
 
} 
  
이상 의 경우 상기 2 의 오류 정보 가 발생 합 니 다.
이 사례 를 해결 하 는 방안 은 class 에 문서 블록 설명 을 다시 설명 하 는 것 입 니 다.
 
/** 
 *               
 *@package haha 
 * 
 */ 
/** 
 *   test  
 */ 
class test { 
 
} 
  
*********************************************** 
사례 2:
 
/** 
 *               
 */ 
 
/** 
 *               
 *@package haha 
 * 
 */ 
class test { 
 
} 
  
상기 문제 중의 1/2 의 상황 이 발생 할 것 이다.
해결 방안 도 사례 1 의 해결 방안 과 같다.
*********************************************** 
사례 3:
 
/** 
 *               
 *@package haha 
 * 
 */ 
define('yyyy', 'hahha'); 
  
위 와 같은 상황 이 발생 합 니 다.
해결 방안 도 다음 과 같다.
 
/** 
 *               
 *@package haha 
 */ 
/** 
 *      
 */ 
define('yyyy', 'hahha'); 
  
문서 블록 이 올 바 르 면@package 와 관련 된 오류 가 발생 하지 않 습 니 다.
주:
1.주석 에서 주의해 야 할 것 은/*가 아 닙 니 다.   */형식의 주석 은 PHPDoc 에 의 해 해석 되 지 않 습 니 다.그리고  */여러 줄 주석 앞 에*로 시작 하 는 주석 줄 이 아니 어도 해석 되 지 않 습 니 다.
2.태그 가 설명 되 어 있 지만 관련 태그 의 필수 옵션 을 제시 하지 않 으 면 Error 메 시 지 를 보 냅 니 다.예 를 들 어@var 뒤에 변수 가 없고@return 뒤에 형식 을 되 돌려 주지 않 으 면 Error 오류 가 발생 합 니 다.해결 방법 은 완전 을 보충 하거나 없 으 면 제거 하 는 것 이다.
또한 명령 행 방식 의 명령 파일 을 제공 하여 Doc 문서 생 성 을 자동 으로 수행 합 니 다.

@Rem:          PHPDoc   
@Rem: author:    [email protected] 
@echo off 
@echo ******************************************************************************* 
@echo           ： 
@echo         PHPDOCumentor,      pear  pear install PhpDocumentor   
@echo 1、option:         ，           ：         
@echo ###1】、HTML:frames:default 
@echo ###2】、HTML:Smarty:default 
@echo ###3】、CHM:default:default 
@echo ###4】、PDF:default:default 
@echo 2、dir:           、 
@echo 3、outputDir:           
@echo 4、title:         
@echo ******************************************************************************* 
 
@set option=HTML:frames:default 
@set dir=D:\PHPAPP\test 
@set outputDir=D:\PHPAPP\doc 
@set title=PHPWindDoc 
 
@phpdoc -d %dir% -o %option% -ti %title% -t %outputDir% 
@echo     ！     
@pause 
주:이 명령 은 명령 줄 에 있 는 PHPDocumentor 패 키 지 를 설치 해 야 합 니 다.설치 방식 은 pear 로 설치 합 니 다.
삼가!
이 편 은 phpdoc 내 보 내기 문서 에서@package 의 warning 및 Error 의 오 류 를 완벽 하 게 해결 하 는 것 이 바로 작은 편집 이 여러분 에 게 공유 하 는 모든 내용 입 니 다.참고 하 시기 바 랍 니 다.여러분 들 도 많이 응원 해 주시 기 바 랍 니 다.