이러한 PHPDOC 속성의 목적은 무엇입니까? 일반적으로

Question

의하는 PHPDoc 속성은 설명,하지만 난 힘든 시간이를 이해하는 데 :

@category을 -이 정확히 무엇인가?

@package -이 속성의 사용법에 대한 예가 있습니까?

Answer 1

패키지 태그는 코드에서 사용하는 주요 조직 태그입니다. phpDocumentor가 문서를 생성하면, 사용자가 설정 한 패키지에 요소를 수집합니다. 일부의 경우 전체 코드베이스에 대해 하나의 패키지 이름 (@package MyPackage) 만 사용하도록 선택하면 모든 파일, 클래스 등이 해당 패키지의 문서에 나타납니다.

그러나 모듈 식으로 구성하는 경우 모든 웹 관련 절차 파일을 하나의 패키지 (@package 웹 페이지), 패키지의 모든 데이터베이스 지향 클래스 (@package DatabaseHandlers), 모든 유틸리티 클래스 패키지 (@package Utilites), 계속해서.

@package에 대해 기억해야 할 중요한 사항은 을 문서화하는 것이 가장 좋은 방법이라는 것입니다. ... 코드 실행 방법과 아무 관련이 없습니다. 분명히 당신은 당신의 머리 속에 당신의 앱 조각을 어떻게 개념적으로 구성하는지에 따라 문서를 구성 할 수 있습니다. 따라서이 패키지에서 은 인 것처럼 느껴질 것입니다. 코드 ...하지만 결국 패키지 태그는 phpDocumentor가 문서를 구성하는 방법에 관한 것입니다.

카테고리 태그에 대해서는 출력 변환기가 PEAR 프로젝트에 중요한 것을 제외하고는 사용하지 않는다고 생각합니다. 카테고리는 패키지 세트를 하나의 큰 묶음으로 수집하는 데 사용됩니다. 그러나 이것은 이미 출력 변환기에 어떤 기능이 내장되어 있는지에 관계없이 PEAR에만 해당됩니다. 수 원할 경우이 태그를 무시하십시오. 은 패키지 태그를 무시합니다. phpDocumentor가 문서를 구성하는 방법의 핵심이기 때문에이 태그를 무시하십시오.

@package를 사용하는 예에 대해서는 이미 언급 한 것처럼 설명서에 몇 가지가 있습니다. 짧게 말하면, 모든 파일의 파일 수준 docblock에 패키지 태그가 필요합니다 (전역 적으로 지정된 함수와 상수는 "패키지"를 가져옵니다). 그리고 모든 클래스의 docblock에 패키지 태그가 필요합니다. 이러한 코드 요소에 대한 패키지 값을 제공하지 않으면 phpDocumentor는 모든 패키지를 "기본"패키지로 덤프해야합니다.

마지막으로 ... 코드를 다양한 패키지로 구성하는 것에 신경 쓰지 않고 모든 파일을 편집하여 @package 태그를 추가하지 않으려면 대신 -dn 런타임 인수를 사용하여 기본 패키지 이름 [1]을 설정하십시오. 이것은 phpDocumentor에게 패키지 이름을 원하는 모든 "패키지되지 않은"코드 요소에 대해 해당 인수에서 제공 한 패키지 이름을 사용하도록 지시합니다. 기본 범주 이름을 설정하는 -dc 인수도 있지만 phpDocumentor와 관련해서는 훨씬 덜 중요합니다.

[1] - http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.defaultpackagename

Answer 2

@category

는 @category 태그 함께 패키지 그룹을 구성하는 데 사용된다.

이것은 XML에 직접 적용 입니다 : DocBook으로/peardoc2 변환기 및 다른 컨버터를 사용할 수 있습니다. 기타 phpDocumentor와 함께 패키지로 제공되는 변환기 은 범주를 무시하지만 이후 버전에서는 으로 변경 될 수 있습니다. 그것은 --defaultcategoryname 명령 줄 스위치 동적 -dc를 사용 카테고리를 지정할 수도 이다

@package 만 문서를 사용할 수 @package

http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.category.pkg.html

절차 페이지 또는 클래스.

패키지는 관련 요소를 논리적으로 그룹화하기 위해 사용됩니다. 당신은 그룹과 관련된 그룹을 작성하고 함수와 데이터를 합쳐서 phpDocumentor는 파일 (함수, 정의 및 포함)의 내용을 "절차 페이지"로 나타냅니다. 패키지는 클래스를 그룹화하고 절차 페이지를 함께 사용하여 과 같은 방식으로 디렉터리 그룹이 관련 파일 과 함께 그룹화하는 데 사용됩니다.

http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.package.pkg.html