Sami와 PHP 문서 생성

SAMI : PHP

에 대한 강력한 API 문서 생성기 PHP 방법, 클래스 및 기능에 대한 별도의 문서 생성이 모범 사례입니다. 이 기사는이 프로세스를 단순화하여 가독성과 접근성을 향상시키는 강력한 API 문서 생성기 인 Sami를 소개합니다.

SAMI의 주요 특징 :

PHP 코드에 대한 독립형 문서를 생성하여 소스 코드를 직접 탐색 할 필요가 없습니다. PHAR 아카이브 또는 작곡가를 통한 쉬운 설치 PHP 구성 파일을 통해 고도로 구성 가능하며 테마, 제목, 빌드 디렉토리 및 캐싱을 사용자 정의 할 수 있습니다. 는 개인화 된 모양과 느낌을 위해 사용자 정의 테마 및 자산 포함을 지원합니다. 는 GIT 버전 컨트롤과 통합되어 여러 코드베이스 버전에 대한 문서를 활성화합니다.

docblocks 이해 : docblocks는 Sami에게 필수적입니다. 클래스, 인터페이스, 메소드 또는 속성 정의 위에 배치 된 멀티 라인 주석입니다. 다음은 laravel 예입니다.

docBlocks는

로 시작하고 로 끝나고 각 줄은 로 시작합니다. 및
• 와 같은 주석은 추가 정보를 제공합니다. PHPDocumentor의 주석 표준이 널리 지원됩니다
Sami vs. 다른 발전기 :
• 다른 생성기 (예 : Phpdocumentor)가 존재하는 동안 Sami는 Github 통합 및 Twig 템플릿 기능으로 인해 두드러집니다.
SAMI 설치 :
• 이 방법 중 하나를 선택하십시오
Phar Archive :
• 다운로드
및 run . Composer :
를 사용하여 프로젝트에 Sami를 추가하십시오. 그런 다음 <.>

LARAVEL 문서 생성 (예) :

Laravel 프레임 워크를 복제하십시오 :

파일을 만듭니다 (아래 구성 섹션 참조)

abstract class Manager
{
    /**
     * The application instance.
     *
     * @var \Illuminate\Foundation\Application
     */
    protected $app;

    /**
     * Create a new manager instance.
     *
     * @param \Illuminate\Foundation\Application $app
     * @return void
     */
    public function __construct($app)
    {
        $this->app = $app;
    }
}

run :

/** 구성 () : */ 이 파일은 a * 인스턴스를 반환합니다 @param 업데이트 명령을 실행 한 후 PHP 서버 ()를 시작하고 에서 문서에 액세스하십시오. @var

git versionsing : Sami는 여러 개의 git 버전을 처리 할 때 탁월합니다. 구성에

versions 사용자 정의 테마 만들기 : Sami는 사용자 정의 테마를 만들 수 있습니다. 테마 디렉토리에 a 파일을 배치합니다 (예 : ) :

그런 다음 CSS를 포함하도록 . 문서를 재생하려면

abstract class Manager
{
    /**
     * The application instance.
     *
     * @var \Illuminate\Foundation\Application
     */
    protected $app;

    /**
     * Create a new manager instance.
     *
     * @param \Illuminate\Foundation\Application $app
     * @return void
     */
    public function __construct($app)
    {
        $this->app = $app;
    }
}

를 실행하십시오

%version% build_dir 결론 : cache_dir SAMI는 PHP 프로젝트를위한 고품질 API 문서를 생성하기위한 강력하고 유연한 솔루션을 제공합니다. GIT 버전 및 사용자 정의 테마 지원을 포함한 기능을 포함하여 모든 PHP 개발자에게 유용한 도구가됩니다. 전체 예제는 GitHub에서 사용할 수 있습니다 (이 예제에 GitHub 리포지션이 있으면 여기에 링크가 추가됩니다).

위 내용은 Sami와 PHP 문서 생성의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!