일반 자료실

제목 phpDocumentor (phpDoc)
글쓴이 ci세상 작성시각 2009/08/08 02:27:03
댓글 : 1 추천 : 0 스크랩 : 0 조회수 : 16107   RSS

다운사이트
http://www.phpdoc.org/


phpDocumentor 사용하기


기본적인 순서는 다음과 같습니다.
1. php 코드에 phpDoc으로 출력하기 위한 내용들을 주석에 작성을 합니다.
2. phpDoc을 생성하기 위한 입/출력 폴더를 지정합니다.
3. 프로그램을 시작하면, php파일을 컴파일 하면서
4. php 소스안에 정의되어 있는 tag들을 파싱하여서 문서로 생성합니다.


 주의할 점
phpDoc을 사용하여 문서를 작성할 때 주의하여야할 점들이 몇 가지 있습니다.

1. 기본 charset이 iso-8859-1로 설정되어 있어서 utf-8로 작성된 소스코드의 주석이 깨지는 문제가 있습니다. *.tpl 파일 들을 검색해서 utf-8로 변경해줘야 합니다. (phpDocumentor/Converters 아래의 파일들이 변환에 사용되는 템플릿 들입니다.)

2. 주석을 사용할 때 /* 로 시작되는 주석들은 문서로 생성이 되지 않습니다. /** 로 시작되어야지만 문서에 포함이 됩니다.

3. class에 속하는 주석은 class 바로 윗 줄에 작성되어져야 합니다. 떨어져 있는 경우 (주석과 class 키워드 사이에 다른 코드가 들어있는 경우) 해당하는 주석으로 처리되지 않고 생략이 됩니다.
/**
 * 주석
 */
class Test ...

4. 코드를 설명하는 글을 먼저 작성하고 태그가 나와야 합니다.
/**
 * 이 코드는 어떤 코드입니다. Blah Blah~
 * @var string ...
 */

5. todo의 경우, @todo로 태그를 작성해야하며 class,function,var의 주석안에 포함되어야지만 보여집니다. 수정해야 될 코드에 @todo를 입력하는 경우 처리되지 않습니다.

6. php 코드 선언 부가 <? ?> 가 아닌 <?php ?>로 모두 선언되어야 합니다. 경우에 따라서는 안나오는 경우도 있네요.

 다음글 Devtool_v4 (3)
 이전글 XP에서 메모리 4기가 풀로 활용 (1)

댓글

양승현 / 2009/08/20 11:06:23 / 추천 0
CI로 CMS를 만들면서 phpDoc를 염두해두고 작업을 하는중이긴 한데.. 이게 잘 돌아갈지는 의문이네요.. ㅎㅎ
아직은 좀 불안정한것 같기도 하고, 머 해봐야죠 ㅎㅎ
프로젝트 끝내면서 메뉴얼 만들때 유용한 툴인건 확실합니다. ㅎㅎ