phpDocumentor 다운로드 - phpDocumentor 소스 코드 다운로드

phpDocumentor

기타 카테고리

v3.5.3

다운로드

PHP문서

phpDocumentor란 무엇인가요?

phpDocumentor는 PHP 프로젝트를 위한 사실상의 문서 도구로서 포괄적인 문서를 쉽게 생성할 수 있는 강력한 솔루션을 제공합니다. phpDocumentor는 PHP 소스 코드와 DocBlock 주석을 분석하여 완전한 API 문서 세트를 생성하므로 명확하고 잘 문서화된 코드베이스를 위해 노력하는 개발자에게 없어서는 안 될 도구입니다.

API 문서의 탁월함을 넘어 phpDocumentor는 추가 기능을 제공하여 더욱 발전합니다. UML 다이어그램을 생성하는 기능이 탑재되어 있어 코드 구조를 시각화하는 다목적 도구입니다. 또한 phpDocumentor는 RestructuredText 및 Markdown 구문을 모두 지원하는 모든 기능을 갖춘 마크업 언어 파서를 제공합니다. 이러한 유연성을 통해 귀하는 자신의 선호도에 가장 적합한 마크업 언어를 사용하여 프로젝트를 문서화할 수 있습니다.

phpDocumentor의 주목할만한 기능은 API 문서의 일부를 RestructuredText 문서에 직접 포함시키는 기능입니다. 이러한 통합을 통해 문서와 코드의 동기화가 유지되므로 정확한 최신 프로젝트 문서를 유지하는 데 드는 시간과 노력이 절약됩니다.

이전 버전인 phpDocumentor 1 및 JavaDoc에서 영감을 받은 phpDocumentor는 최신 기술과 PHP 언어 기능을 최신 상태로 유지하면서 계속해서 혁신하고 있습니다. 이러한 노력을 통해 개발자는 최신 개발 관행에 맞춰 최상의 문서 경험에 액세스할 수 있습니다.

이 가이드에서는 API 문서 생성의 핵심 기능부터 마크업 언어 구문 분석의 고급 기능에 이르기까지 phpDocumentor의 다양한 기능을 살펴보겠습니다. 초보자이든 숙련된 개발자이든 관계없이 phpDocumentor는 잘 문서화되고 유지 관리 가능하며 이해하기 쉬운 PHP 프로젝트를 만드는 데 도움이 됩니다.

phpDocumentor v3 (안정적)

v3은 최신 안정 릴리스입니다.

선적 서류 비치

자세한 내용은 https://docs.phpdoc.org/에서 온라인 설명서를 확인하세요.

특징

phpDocumentor는 다음을 지원합니다:

PHP 7.0+ 호환 , 네임스페이스, 클로저 등에 대한 완벽한 지원이 제공됩니다.
유형에 대한 Docblock , docblock은 기본 PHP에서 모든 형식을 지원하지 않는 유형에 대해 더 명시적일 수 있습니다.
모든 태그를 표시하며 , 일부 태그는 phpDocumentor에 추가 기능을 추가합니다(예: @link).
낮은 메모리 사용량 , 소규모 프로젝트의 최대 메모리 사용량은 20MB 미만, 중간 프로젝트는 40MB, 대규모 프레임워크는 100MB입니다.
증분 구문 분석 , 이전 실행의 구조 파일을 유지한 경우 위에서 언급한 처리 속도 증가 외에 최대 80%까지 추가 성능 향상을 얻을 수 있습니다.
간편한 템플릿 구축 , 브랜딩을 만들고 싶다면 작업 1개를 호출하고 파일 3개만 편집하면 됩니다.
2단계 프로세스인 phpDocumentor는 출력을 생성하기 전에 먼저 애플리케이션 구조로 캐시를 생성합니다. 원한다면 이를 사용하여 자신의 도구나 포맷터를 강화할 수 있습니다!
일반 지원 , PHP 유형의 정적 분석이 더욱 복잡해졌습니다. phpDocumentor는 이러한 유형을 이해합니다. 그리고 그것들을 일류 유형으로 렌더링할 것입니다.

설치

PhpDocumentor를 실행하려면 PHP 8.1 이상이 필요합니다. 그러나 이전 PHP 버전의 코드는 분석할 수 있습니다.

phpDocumentor와 함께 제공되는 모든 템플릿은 읽기 코드 기반을 기반으로 클래스 다이어그램을 지원합니다. 이를 위해서는 phpDocumentor를 실행하는 시스템에 [PlantUml] 애플리케이션을 설치해야 합니다. [PlantUml]을 사용하여 클래스 다이어그램을 렌더링하는 것은 선택 사항이며 [PlantUml] 누락에 대한 경고는 무시할 수 있습니다. 그러나 이 경우 문서에는 일부 데드 링크가 포함됩니다. 클래스 다이어그램은 --setting=graphs.enabled=true 옵션을 사용하여 생성됩니다.

phpDocumentor를 설치하는 방법에는 4가지가 있습니다:

Phive 사용(권장)
PHAR 사용(수동 설치)
도커를 통해
작곡가를 통해

Phive 사용

$ phive install phpDocumentor --trust-gpg-keys 8AC0BAA79732DD42

phive에 대한 자세한 내용은 해당 웹사이트를 참조하세요. 이제 phpDocumentor가 설치되었으므로 다음과 같이 실행할 수 있습니다.

php tools/phpDocumentor

PHAR 사용

https://github.com/phpDocumentor/phpDocumentor/releases에서 phar 파일을 다운로드합니다.
다음과 같이 phar를 실행할 수 있습니다: php phpDocumentor.phar

도커를 통해

$ docker pull phpdoc/phpdoc
$ docker run --rm -v $(pwd):/data phpdoc/phpdoc

Composer를 통해(권장되지 않음)

그런데 잠깐만요? 작곡가는 어떻습니까?

아, 우리 비밀을 발견하셨군요. phpDocumentor를 설치하는 데 사용할 수 있는 phpdocumentor 작성기 패키지가 있습니다.

그러나 phpDocumentor는 복잡한 응용 프로그램이며 해당 라이브러리는 수많은 다른 라이브러리 및 응용 프로그램에서 사용됩니다(우리 라이브러리 중 2개는 각각 1억 5천만 건 이상의 다운로드를 보유하고 있습니다). 이는 우리의 종속성과 귀하의 종속성 중 하나가 충돌할 가능성이 높다는 것을 의미합니다. 그리고 제가 높다고 하면 정말 높습니다.

따라서 위의 이유로 인해 우리는 Composer를 사용하여 phpDocumentor 설치를 보증하거나 적극적으로 지원하지 않습니다.

phpDocumentor를 어떻게 사용하나요?

phpDocumentor를 실행하는 가장 쉬운 방법은 다음 명령을 실행하는 것입니다:

$ phpdoc run -d <SOURCE_DIRECTORY> -t <TARGET_DIRECTORY>

이 명령은 -d 인수를 사용하여 제공된 소스 코드를 구문 분석하고 -t 인수가 지정한 폴더에 출력합니다.

phpDocumentor는 문서의 출력을 구성하는 다양한 옵션을 지원합니다. 다음 명령을 실행하거나 웹사이트에서 사용 가능한 명령줄 옵션의 자세한 목록을 확인할 수 있습니다.

$ phpdoc run -h

구성 파일

phpDocumentor는 구성 파일(기본적으로 phpdoc.xml 또는 phpdoc.dist.xml)의 사용도 지원합니다. 형식과 지원되는 옵션을 보려면 설명서를 참조하세요.

야간 빌드

PhpDocumentor에는 야간 릴리스가 없습니다. 그러나 각 파이프라인 중에 phar 아티팩트가 빌드됩니다. phpDocumentor의 최첨단 버전을 테스트하려면 이 저장소의 작업 섹션을 살펴보세요. 성공적인 각 QA 워크플로 하단에는 phar 아티팩트가 빌드된 아티팩트 섹션이 있습니다.