주석 다는법을 배워야겠습니다.
기존에 제가 사용하던 주석은 함수 별 구분 및 간략 설명을 하는 용도로만 사용 했는데 주석을 새분화 하여 관리 하고 여타 양식들과 맞춰야 한다는 생각이 문득 드네요.
기본적인 PHP 주석
[code]
<?php
/**
* 간략설명
*
* @author 작업자/작성자
* @version 버전
* @package 패키지명
*/
?>
[/code]
함수의 주석
[code]
/**
* 간략 설명
* @param 전달되는 파라미터들
* @return 반환되는 파라미터들
* @access 접근할수 있는 권한 <public(공용) 또는 private(귀속) >
* @static ???
*/
function foo()
{
} // end func
[/code]
클래스의 주석
[code]
/**
* 간략 설명
* @package 패키지명
* @subpackage 서브패키지명
* @abstract ??????
*/
class boo
{
} // end class
[/code]
???를 제외한 주석의 쓰임을 알것 같은데 나머지는 모르겠네요 ㅎㅎ
패키지 명 구분도 어중간 하고...
다른분들의 작성 요령을 배우고 싶습니다.~
|
댓글을 작성하시려면 로그인이 필요합니다.
댓글 6개
간략 설명을 적으면 될 듯 하네요.
전 패키지라 부를 정도의 작업을 안 해봐서 어떻게 쓰는지는 모르고 그냥 아래처럼 적습니다ㅎㅎ
/*
내맘대로 주석1
내맘대로 주석2
*/
혼자 하면 필요한 정보만 적어 두는데 ㅎㅎ
그냥 막그냥 확그냥 ..... 적어 두는게 최고인듯 합니다.
주석많이 적었다고 욕먹은적은 없으니 .... ㅎㅎ
그런데 외국에서는 소스 다이어트/화이트 스페이스 가리는것이 많더라구요