[2015:1] phpdocumentor 설치와 사용법

phpdocument우리의 코드를 예쁘게 포장하는 방법

phpDocumentor 란 ?제작한 프로젝트에 대해서 주석을 이용하여 문서화 해주는 도구

Php 가 스크립트 언어에서 오브젝트 언어로 변화하는 시점=> Javadoc 과 같은 자동화 도구가 가능해짐

phpDocumentor 란 ?

주석이란 ?자신을 포함하여 프로젝트에 참여하는 사람들에게

이해할 수 있도록 도와주는 역할

# 한 줄 주석 사용

// 한 줄 주석 사용

/* 여러 줄 주석 사용닫을 때까지 마음대로 쓸 수 있습니다 . */

주석이란 ?

Ex>

/*

* 이름 변수값 할당 받아서 출력해 주는 함수 * : 여러 줄 주석 */

public function getName(name)

{

// 이름 변수에 할당하는 부분 : 한 줄 주석 $str_name = name ? name : null;

return $str_name;

}

주석이란 ?

여러 줄 주석

한 줄 주석

/**

* { 원하는 내용 넣기 }

*/

Phpdoc 사용법

함께 사용할 수 있는 대표적인 데이터 표현 방식@author 작성자@copyright 저작권 표시@param 파라미터 정보@see 참고한 레퍼런스 정보@return 리턴 값 정보

Phpdoc 사용법

참고 : http://www.phpdoc.org/docs/latest/index.html

1. PHP 5.3.32. Intl extension for PHP3. Graphviz

Phpdoc 요구 스펙

1. composer 를 이용한 방법2. Pear 를 이용한 방법

Phpdoc 설치 방법

Phpdoc 설치 방법 : composer 를 이용한 방법

Composer 는 의존성 관리 도구 .해당 프로젝트가 의존하고 있는 라이브러리를

변경 및 업데이트 등을 관리해주는 역할을 한다 .

1. composer.phar 생성2. 실행파일 생성 : composer.bat3. 세팅 파일 생성 : composer.json4. Phpdoc 다운로드 진행5. phpdoc 확인

Phpdoc 설치 방법 : composer 를 이용한 방법

Phpdoc 설치 방법 : composer 를 이용한 방법1. composer.phar 생성

Phpdoc 작업을 시작할 폴더에서 인스톨러 파일 제작> php –r “eval(‘?>’.file_get_contents(‘https://getcomposer.org/in-staller’));”

Composer.phar 파일 생성 확인

• Php 명령어를 사용할 수 없을 때 대처- Php 명령어를 사용하기 위해서는 php 가 글로벌로 선언되어 있어야 한다 Ex> 내컴퓨터 - 시스템 속성 - 환경변수 의 시스템 변수 PATH

php 경로 입력 C:\xampp\1.8.3\php; 추가

Phpdoc 설치 방법 : composer 를 이용한 방법1. composer.phar 생성

Composer.phar 를 이용하여 bat 파일로 생성> echo @php “%~dp0composer.phar” %*>composer.-bat

Composer.bat 파일 생성 확인

Composer 동작 확인 : 정상 동작할 경우 com-poser 버전 출력> composer -V

Phpdoc 설치 방법 : composer 를 이용한 방법2. 실행파일 생성 : composer.bat

Phpdoc 설치 방법 : composer 를 이용한 방법2. 실행파일 생성 : composer.bat

Composer.json 파일 생성{

"require-dev": {

"phpdocumentor/phpdocumentor": "2.*"

}

}

Phpdoc 설치 방법 : composer 를 이용한 방법3. 세팅 파일 생성 : composer.json

Phpdoc 설치 방법 : composer 를 이용한 방법3. 세팅 파일 생성 : composer.json

composer 를 이용해서 phpdoc 을 사용할 수 있도록 다운로드 진행> php composer.phar install

Phpdoc 설치 방법 : composer 를 이용한 방법4. Phpdoc 다운로드 진행

Phpdoc 설치 방법 : composer 를 이용한 방법4. Phpdoc 다운로드 진행

Phpdoc 설치 방법 : pear 를 이용한 방법

php 확장과 응용프로그램 저장소(PHP Extension and Application Repository)

재사용 가능한 php 컴포넌트를 위한 시스템

1. pear 명령어 실행2. phpdoc 확인


> pear channel-discover pear.phpdoc.org

> pear install phpdoc/phpDocumentor


Phpdoc 설치 방법 : pear 를 이용한 방법 - 오류


> pear upgrade pear

> pear upgrade Console_Getopt

> pear upgrade Structures_Graph

> pear install PhpDocumentor

Phpdoc 제작 방법변환할 코드

phpdoc 실행하여 문서 제작하기> phpdoc run –d “{ 소스폴더 }” –t “{ 제작폴더 }”

Phpdoc 제작 방법

Phpdoc 제작 방법 – Graphviz 설치

Phpdoc 의 그래프를 시각화 해주는 오픈 소스

참고 : http://www.graphviz.org/

Phpdoc 제작 방법 – Graphviz 설치

참고 : http://www.graphviz.org/

1. 다운로드2. 설치3. 환경 변수 등록

Phpdoc 제작 방법 – Graphviz 설치1. 다운로드

1. 자신의 운영체제에 맞는 다운로드 페이지 접속Download – windows

2. 버전에 맞는 설치 파일 다운로드graphviz-2.38.msigraphviz-2.38.zip

Phpdoc 제작 방법 – Graphviz 설치2. 설치

* graphviz-2.38.msi : 클릭하여 설치

Phpdoc 제작 방법 – Graphviz 설치2. 설치

* graphviz-2.38.zip : 압축 해제

Phpdoc 제작 방법 – Graphviz 설치3. 환경변수 등록

1. 환경 변수 등록 : Graphviz 명령어 (dot) 를 사용할 수 있도록등록하지 않았을 때 phpdoc 생성 시 ‘ dot’ 을 사용할 수 없다는 에러가 출력된다 .Error> Error – Unable to find `dot` command of the GraphViz package

2. Graphviz 를 사용할 수 있는지 테스트 : 사용할 수 없음> dot -V


1. 환경변수 등록내 컴퓨터 – 시스템 속성 – 고급 시스템 설정 – 고급 탭 – 환경 변수

2. 시스템 변수의 ‘ PATH’ 변수에 Graphviz 의 bin 폴더 등록ex> { 기존내용 };D:\phpdoc\graphviz-2.38\release\bin

3. Graphviz 를 사용할 수 있는지 테스트 : 버전 확인> dot -V

마무리

설치와 사용법보다 중요한 것은 내용물이다 .체계적인 코드를 작성할 때 phpDocumentor 가 빛을 발할 수

있다 .

그리고 약간의 의지 .

마무리

도구는 도구일 뿐이다 .도구를 사용하는 것은 결국 사람이다 .

[2015:1] phpdocumentor 설치와 사용법

Internet