TIP게시판
| 제목 | ci project phpdoc사용을 위한 주석 | ||
|---|---|---|---|
| 글쓴이 | 양승현 | 작성시각 | 2009/08/20 15:31:26 |
|
|
|||
<?php /** * 클래스 영문설명 * * 클래스 한글설명 * * Created on 2009. 8. 20. * @package application * @subpackage controllers * @category admin * @author seunghyun yang <alvajini@gmail.com> * @link http://codeigniter-kr.org * @version 0.1 */ Class Comment_test extend Controller{ /** * 이부분은 해당 function에 대한 설명 * * @access private : 접근형태 * @param String $a : 넘어오는 매개변수의 형태 및 변수명 및 설명 * @param Array $data : 배열명 및 설명 * @return Array $return : 리턴되는 값 설명 */ function test($a,$data){ // -------------------------------------------------------------------------- // 각 부분별 주석 if(){ } // -------------------------------------------------------------------------- // 각 부분별 주석 for(){ } return $return; } } /* End of file comment_test.php */ /* Location: /application/controllers/admin/comment_test.php */ ?>앞으로 수많은 라이브러리와 컨트롤러 모델등이 생성될건데요. 전에 ci세상님이 말씀하신 phpdoc를 이용해 메뉴얼등을 생성할때 위와 같은 주석이 필요하답니다. 꼭 doc만을 위해서기 보다도 위정도 주석이 있다면 공동작업을 할때 해매지 않을듯 합니다.. class의 주석은 package,subpackage,category는 디렉토리 구조를 따라주면 될듯 하고요 다른건 초기 만든사람 맴대로.. 이클립스를 사용하신다면 템플릿에 클래스용 코멘트,함수용 코멘트 등을 설정해두고 사용하시면 됩니다. window > preferences > phpeclipse > php > templates에서 추가하시면됩니다(버전별로 위치는 다를수 있습니다.)  - CI class 용
class ${classname} extends ${class}{
function ${classname}()
{
//Call the type constructor
parent::${class}();
}
${cursor}
}
- CI class comment 용
/**
* ${eng_comment}
*
* ${kor_comment}
*
* Created on ${date}
* @author 이름 <이메일>
* @package ${package}
* @subpackage ${subpackage}
* @category ${category}
* @version ${version}
*/
${cursor}
/* End of file ${file} */
/* Location: /${package}/${subpackage}/${category}/${file} */
name을 comment로 했을경우 comm만 치신후 ctrl+space를 누르면 리스트가 나온답니다. file코멘트의 경우 php파일 생성시에 자동입력되는 머시기(?) 에 넣어두고 사용하셔도 됩니다. function은 기본으로 들어있더군요. 파라미터값이 있는것과 없는것등으로 구분되어 있네요. 제안사항입니다. 나중을 대비하여 ㅎㅎ ps. 개발자전용 게시판에서 복사하였습니다. |
|||
| 다음글 | 에디터플러스에 익숙하신분들 희소식 (12) | ||
| 이전글 | 이클립스 ANT + FTP 사용 (6) | ||
댓글
|
ci세상
/
2009/08/20 15:52:47 /
추천
0
꼭 ! 필요했는데 정의해 주셔서 감사드립니다. ^^
|
|
emc
/
2009/08/20 15:57:52 /
추천
0
svn 커밋시 수정내용
소스안의 수정내용(html, php ) 등도 규칙을 만들어야 할것 같습니다. 수정내용 수정자 날짜 |
|
변종원(웅파)
/
2009/08/20 17:18:03 /
추천
0
수정시에는
클래스전체가 수정되었을 경우에는 제일 상단 주석란 하단에 * 수정내용 * modify by 이름 <이메일> |