나만의 PHP 주석 달기와 기타


1. 페이지 시작 open tag

   php.ini 설정 호환성을 위해서 가능한 다음과 같이 시작함.

   <?php
   ....;
   ?>

   그러나 HTML 코드에서 단순한 함수 호출이나 변수 출력시에는
   <?myfunc()?> 또는 <?=$var?>를 사용함.


2. 페이지 시작 주석

   해당 PHP 페이지가 다른 페이지와 반드시 구별되어야 함을 강조
   할 때에는 다음과 같은 '#' 주석으로 일괄 통일함.
   그러나 이 부분을 생략할 수 있음.

   <?php
   ##
   ## this file name is 'file_name.php'	/*** 파일 이름 기술 ***/
   ##
   ## file descripitions ....		/*** 파일에 대한 내용 ***/
					/*** 1행을 띄움 ***/
   function xxx()


3. 함수 또는 클래스에 대한 설명 주석

   예) 함수 or 클래스 or 파일

   ## get myfunc			/*** 함수에 대한 짧은 설명 1행 ***/
   ##
   ## [function descripition]		/*** 함수에 대한 상세 설명 ***/
   ##
   ## [author]
   ##  - [author_name] < email > [, URL]	/*** 작성자 ***/
   ## [changes]
   ##   - Y.m.d [, [ver 0.2,] comment]
   ##   - Y.m.d [, [ver 0.1,] comment]
   ##
   ## [download]
   ##  - URL			/*** 다운로드 가능한 URL ***/
   ##
   ## [demo]
   ##  - URL
   ##
   ## [reference]
   ##  - URL1				/*** 참고 URL ***/
   ##
   ##
   ## [arguments]
   ##  $var1 array [, comment]
   ##  $var2 integer [, comment]	/*** default is 0 ***/
   ##  $var3 string [, comment]]	/*** default is empty ***/
   ##
   ## [globals]
   ##  $gvar1  boolean [, comment]
   ##  $gvar2  array [, comment]]
   ##
   ## [return]
   ##  $rvar  {array|string|integer|boolean} [, comment]]
   ##
   ## [usage]
   ##  return type function_name(type argv1 [,...])
   ##
   ## [example]
   ##  ...
   ##
   function get_myfunc($var1, $var2=0, $var3='')
   {
     global $gvar1, $gvar2; 

     ....;

     return $rvar;			/*** 필요하다면 주석 추가 ***/
   }


4. 함수 arguments 기본값

   - integer 일 경우 0
   - boolean 일 경우 TRUE, FALSE
   - string 일 경우 '' 


5. return 값

   - return type 명시
   - boolean 일 경우 (boolean)$foo, 또는 TRUE, FALSE 로 명시
   - 가능한 모든 함수는 return 명시


6. 기타

   - 한줄의 주석 설명문일 경우는 맨 오른쪽에 // 사용
   - 여러 줄의 주석 설명문일 경우는 맨 앞줄에 ## 사용
   - 어떤 알고리즘의 한줄을 off 할 경우 //
   - 어떤 알로리즘의 여러 줄을 off 할 경우 /*** ***/

EOF