T

주석 다는법을 배워야겠습니다.

기존에 제가 사용하던 주석은 함수 별 구분 및 간략 설명을 하는 용도로만 사용 했는데 주석을 새분화 하여 관리 하고 여타 양식들과 맞춰야 한다는 생각이 문득 드네요.


기본적인 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개

http://ko.wiktionary.org/wiki/abstract
간략 설명을 적으면 될 듯 하네요.

전 패키지라 부를 정도의 작업을 안 해봐서 어떻게 쓰는지는 모르고 그냥 아래처럼 적습니다ㅎㅎ
/*
내맘대로 주석1
내맘대로 주석2
*/
여러명이서 작업 하다보니 필요성이 생기더라구요 ㅎㅎ
혼자 하면 필요한 정보만 적어 두는데 ㅎㅎ
여러명... 부럽군요ㅠ 전 디자인 빼고는 혼자서 다 해야되는데ㅠㅠ
개인적인 생각으론,
그냥 막그냥 확그냥 ..... 적어 두는게 최고인듯 합니다.

주석많이 적었다고 욕먹은적은 없으니 .... ㅎㅎ
그건 그렇죠 ㅎㅎㅎ
그런데 외국에서는 소스 다이어트/화이트 스페이스 가리는것이 많더라구요
댓글을 작성하시려면 로그인이 필요합니다.

프로그램

8,188건
+
제목 글쓴이 날짜 조회
14-08-01 조회 3,823
14-07-31 조회 3,909
14-07-31 조회 4,766
14-07-30 조회 4,448
14-07-30 조회 4,255
14-07-30 조회 3,998
14-07-30 조회 4,076
14-07-29 조회 6,554
14-07-29 조회 4,400
14-07-28 조회 4,757
14-07-27 조회 4,997
14-07-27 조회 4,176
14-07-26 조회 4,057
14-07-26 조회 4,070
14-07-25 조회 3,516
14-07-25 조회 4,054
14-07-25 조회 4,583
14-07-23 조회 4,523
14-07-23 조회 3,715
14-07-22 조회 4,160
14-07-21 조회 3,664
14-07-21 조회 4,670
14-07-19 조회 4,030
14-07-18 조회 3,404
14-07-18 조회 5,170
14-07-17 조회 9,509
14-07-17 조회 4,141
14-07-17 조회 3,805
14-07-16 조회 4,002
14-07-16 조회 3,558
14-07-16 조회 4,079
14-07-15 조회 3,624
14-07-14 조회 6,210
14-07-13 조회 4,090
14-07-12 조회 4,492
14-07-12 조회 3,870
14-07-11 조회 5,289
14-07-10 조회 4,184
14-07-09 조회 5,585
14-07-08 조회 4,840
14-07-08 조회 5,511
14-07-08 조회 4,305
14-07-08 조회 5,464
14-07-06 조회 4,454
14-07-06 조회 3,814
14-07-05 조회 4,079
14-07-04 조회 8,461
14-07-04 조회 3,970
14-07-04 조회 3,492
14-07-04 조회 3,673
14-07-03 조회 3,816
14-07-03 조회 4,210
14-07-03 조회 4,652
14-07-02 조회 5,007
14-07-02 조회 3,899
14-07-02 조회 4,168
14-07-01 조회 3,937
14-07-01 조회 3,521
14-06-28 조회 5,167
14-06-28 조회 4,441
14-06-28 조회 6,201
14-06-27 조회 3,945
14-06-27 조회 3,800
14-06-27 조회 4,852
14-06-27 조회 5,523
14-06-26 조회 4,932
14-06-26 조회 6,077
14-06-26 조회 4,368
14-06-26 조회 6,440
14-06-26 조회 3,585
14-06-25 조회 3,874
14-06-24 조회 5,316
14-06-24 조회 3,915
14-06-24 조회 5,933
14-06-24 조회 6,076
14-06-24 조회 4,306
14-06-24 조회 5,014
14-06-20 조회 4,079
14-06-20 조회 4,391
14-06-20 조회 3,905
14-06-19 조회 5,127
14-06-18 조회 4,936
14-06-18 조회 4,063
14-06-18 조회 8,391
14-06-12 조회 5,543
14-06-12 조회 6,187
14-06-11 조회 5,090
14-06-10 조회 4,018
14-06-06 조회 5,560
14-06-05 조회 5,409
14-06-04 조회 5,007
14-05-29 조회 4,749
14-05-28 조회 3,914
14-05-27 조회 4,948
14-05-26 조회 5,475
14-05-26 조회 4,268
14-05-23 조회 5,689
14-05-21 조회 4,580
14-05-19 조회 7,520
14-05-18 조회 4,934