2009-07-26 2 views
10

Eclipse + PDT로 개발 중입니다. 내 코드에 의 phpdoc 주석을 추가했지만 실제로 Eclipse에서 결과 문서를 생성하지 않았습니다. 어떻게해야합니까? Eclipse에 일부 기능이 있습니까? 아니면 외부에서 의사 생성을 수행해야합니까?PHPDoc 문서 생성기가 Eclipse 안팎에 있습니까?

답변

5

설명서를 생성하려면 phpDocumentor을 사용해야하며 PEAR 패키지로 설치할 수 있습니다.

그런 다음 명령 줄에서 호출해야합니다. Eclipse PDT에서 실제로 호출 된 것을 본 적이 없습니다.

훌륭한 솔루션은 연속 통합 플랫폼 (예 : phpUnderControl 사용)을 사용하고 빌드 구성 파일에서 phpdoc 생성에 통합하는 것입니다. 이런 식으로, 누군가가 을 커밋 할 때마다 phpdoc가 생성됩니다 (또는 하루에 한 번 또는 ^^ 원할 때마다).

Eclipse PDT에서는 "외부 도구"(메뉴의 "실행> 외부 도구"참조)를 호출 할 수 있습니다. 이렇게하면 phpdoc 명령을 실행할 수 있습니다 (CLI에서와 같이). 그러나 Zend Studio가 제공하는 것만큼이나 사용자 친화적이지는 않습니다. 같은 가격도 아닙니다 ^^

+0

나는 개미를 사용하여 php 프로젝트를 만들었고, 보통 doc 타겟을 가지고있다. 이클립스는 개미와 아주 잘 어울립니다. 또한 당신은 일식에서 핑을 달린다. –

1

예 젠드에서 이것을 수행하는 마법사가 있습니다. 이 brief guide을 확인하십시오.

또는 외부 실행 구성을 만들어 phpDocumentor 표준을 호출 할 수 있습니다.

  1. 선택 실행 -> 외부 도구 -> 외부 도구 구성 ... 왼쪽 창에서
  2. 은 선택 프로그램은 다음 새 아이콘 (창 위의 아이콘 가장 왼쪽).
  3. 오른쪽 창에서 기본 탭을 선택하십시오.
  4. 이름 : 입력란에 generate_doc을 입력하십시오.
  5. 위치 : 필드에 phpdoc cli 도구의 경로를 입력하십시오.
  6. 필수 인수를 인수 필드에 입력하십시오 (예 : 현재 프로젝트 입력 $ {project_loc}.
  7. 외부 구성을 실행하려면 실행을 선택하십시오.

구성을 다시 실행하려면, 당신은 몇 가지 선택이 있습니다

  1. 다음 generate_doc에게
  2. 선택 실행 -> 외부 도구 -> generate_doc을 클릭하고 메뉴 바 external tools icon http://help.eclipse.org/ganymede/topic/org.eclipse.cdt.doc.user/images/icon%5Fext%5Ftools.png"에서 외부 도구 아이콘을 선택을
  3. Hit Alt + R, E, 1 (generate_doc이 목록의 첫 번째 항목이라고 가정) 그렇지 않으면 해당 숫자를 선택하십시오.
+0

감사하지만 일반적인 Eclipse + PDT를 사용하고 있습니다. 분명히 그런 옵션이 없습니다. – AlexA

2

설명서를 생성하는 또 다른 훌륭한 도구는 ApiGen입니다. PEAR과 함께 설치할 필요는 없지만 (포함하지만) 독립 실행 형 패키지처럼 사용할 수 있습니다.

+0

Windows 용 ApiGen을 어떻게 설치합니까?나는'phar' 꾸러미를 다운로드했지만 진행 방법에 대한 단서가 없습니다. –

+0

@SuhailGupta 여기를보세요 : https://github.com/ApiGen/ApiGen –

+0

그래서 'C : \ wamp \ www \ apigen.phar'경로를 사용자 변수'PATH'에 포함 시켰고'System' 통로. 그러나 그것은 효과가 없습니다! 그냥 아무것도 인쇄하지 않습니다. –

관련 문제