PHP 문서 도구 설치 및 사용 방법 PHP Documentor_php 팁

이 글에서는 PHP 문서 도구인 PHP Documentor를 설치하고 사용하는 방법을 설명합니다. 참고하실 수 있도록 모든 사람과 공유하세요. 자세한 내용은 다음과 같습니다.

PHP Documentor는 PEAR에 속한 모듈로, 문서를 생성하는 데 사용됩니다. PHP Documentor는 지정된 디렉터리에 있는 PHP 소스 코드를 스캔하고, 키워드를 스캔하고, 분석이 필요한 주석을 가로채고, 주석에 있는 특수 태그를 분석하고, HTML 파일을 생성한 후, 분석된 클래스 및 모듈을 기반으로 해당 정보를 생성합니다. .html 파일을 색인화하고 생성합니다. 코드를 검토할 때 다소 유용합니다.

1. PHP Documentor 설치

먼저 pear 라이브러리가 설치되어 있는지 확인하세요.

; UNIX: "/path1:/path2" 
include_path = ".:/usr/share/pear" //pear库位置 
; 
; Windows: "\path1;\path2" 
;include_path = ".;c:\php\includes" 

http://pear.php.net/go-pear가 설치되지 않은 경우 파일을 다른 이름으로 저장하세요. 명령줄에서 php go-pear.php를 설치할 수 있습니다. yum을 사용하여 PHP를 설치했는데 설치 중에 pear가 이미 설치되어 있었습니다. pear를 설치한 후 pear install phpDocumentor를 통해 phpdoc을 설치할 수 있습니다

[apacheuser@krlcgcms01 ~]$ phpdoc -h HTML 문서를 생성하려면 세 가지 매개변수이면 충분합니다.

-d 분석할 디렉터리, 여러 디렉터리를 쉼표로 구분
-t 생성된 문서의 저장 경로
-o 출력 문서 형식

2. 제작서류

코드 복사 코드는 다음과 같습니다.

[root@krlcgcms01 test]# phpdoc -d "/ tmp/test /mytest" -t "/tmp/test/doc" -o "HTML:프레임:phpedit"

위 문장은 /tmp/test/mytest 디렉토리의 php 파일에서 문서를 생성하여 /tmp/test/doc 아래에 html 형식으로 넣는다는 의미입니다.

[apacheuser@krlcgcms01 doc]$ ls
blank.html elementindex.html li_首页.html
classtrees_default.html elementindex_首页.html media
classtrees_首页.html errors.html packages.html
default index.html 首页
elementindex_default.html li_default.html

생성된 문서가 저장된 디렉토리로 이동하여 살펴보세요. 시스템에 한자가 설치되어 있지 않아 한자가 깨져 있습니다.

일부 컨텐츠를 다운받으시면 index.html을 브라우저로 살펴보세요

PHP Documentor 문서 도구

1. 위 사진을 보면 문서의 내용은 주로 php 파일에 있는 주석 태그가 나열되어 있고, 해당 파일도 나열되어 있어 보기가 더 편한 것을 알 수 있습니다. 다른 것은 없습니다.

주석 태그는 다음과 같습니다 :

@author 작성자 정보
@const 정의로 정의된 상수
@deprecate 더 이상 사용되지 않는 API
@global 전역변수
@package 패키지 정보
@param 함수 매개변수
@return 반환값
@참조 기능 참조
@소개시간부터
@static 정적변수
@var 클래스 멤버 변수

2. 위 그림에 글자가 깨져 있는 부분이 있습니다. 생성된 HTML의 편집기는
입니다.

코드 복사 코드는 다음과 같습니다.

gbk로 변경하면 잘못된 문자가 표시되지 않습니다.

이 기사가 PHP 프로그래밍에 종사하는 모든 사람에게 도움이 되기를 바랍니다.