PHPDOC 소개

코어 포인트

PHPDOC (PHPDocumentor)는 개발자가 특수 형식 주석을 통해 코드 문서를 작성하는 데 도움이되는 강력한 도구입니다. HTML, PDF 및 CHM과 같은 여러 형식으로 문서를 생성 할 수 있으며 웹 인터페이스 또는 명령 줄 인터페이스를 통해 추출 할 수 있습니다.

PHPDOC는 DocBlocks (멀티 라인 C 스타일 댓글)를 사용하여 코드 블록을 문서화합니다. DocBlocks에는 짧은 설명, 자세한 설명 및 태그의 세 가지 선택 부분이 포함되어 있습니다. 태그는 코드에 대한 추가 정보를 지정하는

기호로 시작합니다.
• PHPDOC 패키지는 생성 된 문서에서 관련 코드 요소를 그룹화하는 데 사용됩니다. 파일 레벨 또는 클래스 수준 DocBlock에서 및 태그를 사용하여 파일 및 클래스의 패키지를 지정할 수 있습니다.
PHPDOC는 파일, 클래스, 기능 및 방법, 클래스 속성, 글로벌 변수,
• 및 @를 포함한 다양한 코드 요소에 대한 문서를 작성할 수 있습니다. 이러한 요소는 특정 공통 태그를 사용할 수 있지만 각각에는 특정 태그가 있습니다.
PHPDOC의 명령 줄 도구는 작성된 PHP 코드를 기반으로 사용자 친화적 인 문서를 생성하는 데 사용됩니다. 이 도구는 다양한 문서 형식을 제공합니다. 명령 줄 인터페이스에 익숙하지 않은 사용자의 경우 PHPDOC도 웹 인터페이스를 제공합니다.
• @package 다른 사람이 작성한 읽기 코드 (누가 경험하지 못한가?)는 어려운 작업입니다. 지저분한 "파스타 스타일 코드"는 다수의 이상한 이름의 변수와 혼합되어 현기증이납니다. 이 기능은 문자열이나 배열을 기대합니까? 이 변수 저장소 정수 또는 개체가 있습니까? 수많은 코드 추적 및 각 부분의 기능을 이해하려고 시도한 후에는 전체 코드를 처음부터 포기하고 다시 작성하는 것이 일반적입니다. 소중한 시간의 낭비입니다. PHPDOC (PHPDocumentor의 짧은 이름)는 특수 형식의 주석을 가진 코드 문서를 쉽게 쓸 수있는 강력한 도구입니다. 문서는 소스 코드뿐만 아니라 웹 인터페이스 또는 명령 줄 인터페이스를 통해 추출한 전문 문서도 제공됩니다. 결과는 HTML, PDF 및 CHM과 같은 다양한 형식 일 수 있습니다. 또한 코드 완성을 제공하는 많은 IDE는 PHPDOC 의견을 구문 분석하고 유형 프롬프트와 같은 실질적인 기능을 제공 할 수 있습니다. PHPDOC를 사용하면 다른 사람 (및 자신)이 글을 쓰고 나서 몇 주, 몇 달 또는 몇 년 후에도 코드를 더 쉽게 이해할 수 있습니다. PHPDOC를 설치하는 가장 쉬운 방법은 Pear를 사용하는 것입니다. 물론, 배를 설치하기 전에 배를 설치해야합니다. 배를 설치하지 않은 경우 pear.php.net/manual/en/installation.php의 지침을 따르십시오. 이 기사에서는 PHPDOC로 처음부터 끝까지 아름답고 사용자 친화적 인 문서를 생성하는 방법을 보여 드리겠습니다. @subpackage
docBlocks
• docBlock은 코드 블록에 대한 문서를 작성하는 데 사용되는 멀티 라인 C 스타일 주석입니다. include()/require()로 시작하고 각 라인에는 별표가 있습니다. 예는 다음과 같습니다.

  <?php
  /**
   * 计算数组中每个元素的平方和
   *
   * 循环遍历数组中的每个元素，将其平方，并将其添加到总和中。返回总和。
   *
   * 此函数也可以使用 array_reduce() 实现；
   *
   * @param array $arr
   * @return int
   * @throws Exception 如果数组中的元素不是整数
   */
  function sumOfSquares($arr) {
      $total = 0;
      foreach ($arr as $val) {
          if (!is_int($val)) {
              throw new Exception("Element is not an integer!");
          }
          $total += $val * $val;
      }
      return $total;
  }

  docBlocks에는 간단한 설명, 자세한 설명 및 레이블의 세 부분이 포함되어 있습니다. 세 부분은 모두 선택 사항입니다. 간단한 설명은 신축성 또는 기간으로 끝나는 간결한 설명입니다. PHPDOC의 분석 루틴은 똑똑합니다. 자세한 설명은 문서의 주요 내용입니다. 자세한 설명과 짧은 설명은 서식을위한 특정 HTML 요소를 포함 할 수 있습니다. 지원되지 않는 HTML 태그는 일반 텍스트로 표시됩니다. PHPDOC는 여러 형식으로 문서를 생성 할 수 있으므로 HTML 태그는 HTML 파일에서와 같이 반드시 렌더링 할 필요는 없습니다. HTML 태그를 텍스트로 표시 해야하는 경우 더블 괄호를 사용하십시오. 예를 들면 :
  DocBlock의 태그 섹션에는 <🎜 🎜> 기호로 표시되는 수많은 특수 태그가 포함되어 있습니다. 태그는 예상 매개 변수 및 해당 유형과 같은 추가 정보를 지정하는 데 사용됩니다. 대부분의 태그는 자체 행에 있어야하지만 일부 태그는 인쇄 될 수 있습니다. 인라인 태그는 곱슬 괄호로 둘러싸여 있으며 자세한 설명과 간단한 설명으로 나타날 수 있습니다. 태그의 전체 목록은 관련 PHPDOC 문서를 확인하십시오.

  <?php
  /**
   * 这里是斜体标签的示例： >Hello, world!>
   */

  기호로 시작하려면 라인이 필요하지만 레이블로 해석하고 싶지 않은 경우 백 슬래시로 탈출 할 수 있습니다. PHPDOC는 자세한 설명과 간단한 설명에서 텍스트 목록을 자동으로 식별하고 구문 분석합니다. 그러나 중첩 된 목록을 올바르게 구문 분석하지 않습니다. 중첩 목록을 사용하려면 HTML 태그를 사용하십시오. 다음은 내가 의미하는 바를 설명하는 예입니다.

  @ (공간 제한으로 인해 다음 내용이 간단히 요약되고 주요 정보를 유지 함) bag @

  PHPDOC 패키지는 생성 된 문서에서 관련 코드 요소를 그룹화하는 데 사용됩니다. 해당 패키지를 상속하기 위해 작성된 코드가 포함 된 파일 및 클래스의 패키지를 지정할 수 있습니다. 패키지를 지정하려면 파일 레벨 또는 클래스 레벨 DocBlock에서 태그를 설정하십시오. (파일 레벨 및 클래스 수준의 문서 블록은 다음 섹션에서 더 자세히 설명합니다). 패키지 이름에는 문자, 숫자, 대시, 밑줄 및 사각형 괄호 ( "["및 "]")가 포함될 수 있습니다. 파일 패키지를 정의하는 방법의 예는 다음과 같습니다.

  <?php
  /**
   * 使用列表的示例
   *
   * PhpDoc 将正确解析此列表：
   * - 项目 #1
   * - 项目 #2
   * - 项目 #3
   *
   * 但不是这个列表：
   * - 项目 1
   *   - 项目 1.1
   *   - 项目 1.2
   * - 项目 2
   *
   * 请改用此方法创建嵌套列表：
   * 

  *
• 项目 1
*
*
• 项目 1.1
*
• 项目 1.2
* *
• 项目 2
* */ 여러 레벨의 패키지 및 하위 포장이있는 경우 태그를 사용하여 하위 포장지를 정의 할 수 있습니다. 예는 다음과 같습니다.

파일 또는 클래스가 패키지를 지정하지 않으면 기본 패키지 "기본값"으로 설정됩니다. 명령 줄 옵션을 통해 기본적으로 사용할 다른 패키지를 지정할 수 있습니다.

어떤 문서를 작성할 수 있습니까?

모든 코드 요소가 docBlocks를 사용하여 작성할 수있는 것은 아닙니다. 다음은 문서에 쓸 수있는 코드 요소 목록입니다.

• 파일
카테고리 기능 및 방법 클래스 속성 글로벌 변수
이러한 모든 요소는 특정 공통 레이블을 사용할 수 있지만 각 요소에는 해당 요소에 맞는 레이블이 있습니다. 일반적으로 문서를 작성하는 데 사용되는 요소와 태그를 다룰 것입니다.
(파일, 클래스, 함수 및 메소드의 문서 예는 간단합니다. 키 태그 설명 만 유지됩니다)
• include()/require() 문서를 생성
PHP 코드의 문서를 작성한 후에는 사용자 친화적 인 문서를 생성해야합니다. 이를 위해 PHPDOC 명령 줄 도구를 실행하십시오.
• define()
(명령 줄 매개 변수 설명은 간단합니다) 명령 줄 인터페이스에 익숙하지 않은 사용자의 경우 PHPDOC도 웹 인터페이스를 제공합니다. 이 문서는이 문서에 대해 자세히 논의하지 않지만 PHPDOC의 공식 웹 사이트 인 phpdoc.org에서 자세히 알아볼 수 있습니다.
요약
이 기사에서는 PHPDOC와 많은 강력한 기능을 소개합니다. 나는 docblocks와 그 구성 요소의 목적을 설명했다. 가장 중요한 부분에 대한 문서를 작성하더라도 자신의 프로젝트에서 PHPDOC를 사용하는 것이 좋습니다. 그것은 매우 간단하고 당신과 당신의 동료들에게 수많은 긴장과 고통을 구할 수 있습니다.

(FAQ 섹션은 핵심 질문과 짧은 답변을 유지하고 짧은 답변을 유지합니다)

위 내용은 PHPDOC 소개의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!