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,779
14-07-31 조회 3,872
14-07-31 조회 4,716
14-07-30 조회 4,386
14-07-30 조회 4,212
14-07-30 조회 3,956
14-07-30 조회 4,031
14-07-29 조회 6,496
14-07-29 조회 4,344
14-07-28 조회 4,702
14-07-27 조회 4,948
14-07-27 조회 4,136
14-07-26 조회 4,022
14-07-26 조회 4,030
14-07-25 조회 3,476
14-07-25 조회 4,011
14-07-25 조회 4,511
14-07-23 조회 4,485
14-07-23 조회 3,680
14-07-22 조회 4,121
14-07-21 조회 3,639
14-07-21 조회 4,639
14-07-19 조회 4,006
14-07-18 조회 3,385
14-07-18 조회 5,143
14-07-17 조회 9,492
14-07-17 조회 4,118
14-07-17 조회 3,778
14-07-16 조회 3,976
14-07-16 조회 3,532
14-07-16 조회 4,062
14-07-15 조회 3,603
14-07-14 조회 6,185
14-07-13 조회 4,051
14-07-12 조회 4,466
14-07-12 조회 3,846
14-07-11 조회 5,265
14-07-10 조회 4,138
14-07-09 조회 5,551
14-07-08 조회 4,794
14-07-08 조회 5,476
14-07-08 조회 4,259
14-07-08 조회 5,428
14-07-06 조회 4,396
14-07-06 조회 3,773
14-07-05 조회 4,030
14-07-04 조회 8,430
14-07-04 조회 3,944
14-07-04 조회 3,469
14-07-04 조회 3,644
14-07-03 조회 3,792
14-07-03 조회 4,183
14-07-03 조회 4,625
14-07-02 조회 4,975
14-07-02 조회 3,880
14-07-02 조회 4,145
14-07-01 조회 3,911
14-07-01 조회 3,498
14-06-28 조회 5,129
14-06-28 조회 4,408
14-06-28 조회 6,173
14-06-27 조회 3,923
14-06-27 조회 3,780
14-06-27 조회 4,834
14-06-27 조회 5,493
14-06-26 조회 4,889
14-06-26 조회 6,039
14-06-26 조회 4,346
14-06-26 조회 6,415
14-06-26 조회 3,562
14-06-25 조회 3,839
14-06-24 조회 5,276
14-06-24 조회 3,873
14-06-24 조회 5,899
14-06-24 조회 6,036
14-06-24 조회 4,282
14-06-24 조회 4,984
14-06-20 조회 4,046
14-06-20 조회 4,356
14-06-20 조회 3,873
14-06-19 조회 5,088
14-06-18 조회 4,907
14-06-18 조회 4,042
14-06-18 조회 8,361
14-06-12 조회 5,506
14-06-12 조회 6,138
14-06-11 조회 5,052
14-06-10 조회 3,968
14-06-06 조회 5,503
14-06-05 조회 5,338
14-06-04 조회 4,970
14-05-29 조회 4,704
14-05-28 조회 3,868
14-05-27 조회 4,918
14-05-26 조회 5,417
14-05-26 조회 4,218
14-05-23 조회 5,653
14-05-21 조회 4,538
14-05-19 조회 7,484
14-05-18 조회 4,899