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건
+
제목 글쓴이 날짜 조회
16-06-03 조회 3,009
15-07-30 조회 3,402
15-06-08 조회 5,547
15-05-27 조회 4,408
15-01-08 조회 6,703
14-12-30 조회 5,435
14-10-10 조회 5,426
14-08-13 조회 6,344
14-08-11 조회 5,201
14-08-06 조회 6,530
14-03-19 조회 7,429
13-04-26 조회 9,585
12-12-15 조회 5,108
12-12-15 조회 7,342
12-12-11 조회 5,477
12-11-21 조회 6,009
12-10-11 조회 5,091
12-10-03 조회 4,782
12-09-20 조회 6,080
12-09-02 조회 4,267
12-08-29 조회 5,258
12-08-29 조회 4,148
12-08-24 조회 4,244
12-08-18 조회 4,473
12-08-17 조회 4,514
12-08-16 조회 3,768
12-08-06 조회 5,547
12-08-05 조회 4,834
12-08-03 조회 4,550
12-08-03 조회 4,692
12-07-29 조회 3,553
12-07-24 조회 4,137
12-07-22 조회 3,609
12-07-20 조회 4,361
12-07-19 조회 4,711
12-07-19 조회 3,942
12-07-19 조회 3,887
12-07-19 조회 5,554
12-07-19 조회 3,498
12-07-18 조회 5,177
12-07-15 조회 4,155
12-07-14 조회 3,829
12-07-12 조회 4,505
12-07-11 조회 3,780
12-07-11 조회 3,500
12-07-11 조회 3,470
12-07-10 조회 4,655
12-07-09 조회 3,407
12-07-09 조회 4,228
12-07-09 조회 4,646
12-07-08 조회 4,561
12-07-07 조회 5,488
12-07-06 조회 4,739
12-07-06 조회 4,010
12-07-06 조회 3,895
12-07-06 조회 3,826
12-07-02 조회 5,508
12-07-02 조회 4,206
12-06-29 조회 3,729
12-06-28 조회 4,354
12-06-26 조회 3,848
12-06-26 조회 4,970
12-06-21 조회 3,944
12-06-20 조회 4,646
12-06-20 조회 4,275
12-06-15 조회 4,631
12-06-15 조회 4,369
12-06-13 조회 7,387
12-06-05 조회 7,362
12-06-04 조회 3,939
12-06-03 조회 3,786
12-05-31 조회 3,784
12-05-28 조회 6,629
12-05-27 조회 3,861
12-05-25 조회 3,995
12-05-23 조회 4,404
12-05-21 조회 5,118
12-05-17 조회 4,052
12-05-17 조회 3,972
12-05-09 조회 4,050
12-05-07 조회 4,300
12-05-02 조회 4,491
12-05-01 조회 4,667
12-04-30 조회 3,413
12-04-30 조회 4,359
12-04-25 조회 4,445
12-04-25 조회 4,871
12-04-24 조회 3,836
12-04-24 조회 4,602
12-04-23 조회 3,605
12-04-20 조회 3,248
12-04-17 조회 5,439
12-04-16 조회 4,377
12-04-14 조회 3,661
12-04-14 조회 3,687
12-04-14 조회 3,736
12-04-13 조회 3,362
12-04-13 조회 4,552
12-04-13 조회 6,186
12-04-12 조회 3,353