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-26 조회 3,427
14-08-26 조회 3,615
14-08-26 조회 4,199
14-08-26 조회 3,548
14-08-26 조회 3,751
14-08-26 조회 3,676
14-08-26 조회 3,479
14-08-26 조회 3,601
14-08-26 조회 3,560
14-08-26 조회 3,703
14-08-25 조회 4,104
14-08-16 조회 4,235
14-08-12 조회 4,119
14-08-05 조회 3,935
14-08-04 조회 4,790
14-08-04 조회 3,964
14-08-01 조회 5,229
14-07-29 조회 4,343
14-07-10 조회 4,138
14-07-08 조회 4,794
14-07-08 조회 4,259
14-07-05 조회 4,029
14-05-26 조회 5,417
14-05-26 조회 4,218
14-05-21 조회 4,538
14-05-19 조회 7,482
14-05-17 조회 6,888
14-04-30 조회 7,289
14-04-27 조회 4,703
14-04-26 조회 4,895
14-04-13 조회 4,883
14-04-13 조회 4,138
14-03-25 조회 6,478
14-03-25 조회 4,137
14-03-12 조회 4,001
14-03-12 조회 5,387
14-02-24 조회 4,697
13-12-27 조회 3,980
13-11-18 조회 4,307
13-11-18 조회 6,766
13-10-17 조회 4,797
13-10-03 조회 6,266
13-10-02 조회 4,167
13-09-29 조회 4,713
13-09-29 조회 4,030
13-09-17 조회 3,797
13-09-11 조회 6,224
13-09-09 조회 4,266
13-09-05 조회 9,532
13-08-23 조회 5,814
13-08-22 조회 5,342
13-08-22 조회 4,551
13-08-22 조회 5,061
13-08-17 조회 5,961
13-08-17 조회 4,308
13-07-11 조회 5,503
13-07-11 조회 4,447
13-07-08 조회 4,052
13-07-04 조회 4,233
13-07-04 조회 4,129
13-07-04 조회 4,006
13-07-03 조회 5,922
13-07-01 조회 3,761
13-07-01 조회 3,711
13-07-01 조회 4,576
13-06-21 조회 6,294
13-06-14 조회 4,845
13-06-11 조회 3,686
13-06-06 조회 5,424
13-06-05 조회 4,145
13-05-11 조회 4,894
13-05-10 조회 4,464
13-05-10 조회 4,669
13-05-10 조회 4,180
13-05-08 조회 4,397
13-05-08 조회 3,664
13-05-08 조회 4,083
13-05-08 조회 5,281
13-04-05 조회 6,048
13-03-31 조회 5,663
13-03-24 조회 4,017
13-03-24 조회 6,200
13-03-23 조회 3,701
13-03-21 조회 3,781
13-03-20 조회 3,766
13-03-20 조회 4,248
13-03-20 조회 3,801
13-03-20 조회 3,882
13-03-20 조회 6,057
13-03-20 조회 4,054
13-03-20 조회 4,738
13-03-19 조회 5,793
13-03-14 조회 3,948
13-03-14 조회 4,279
13-03-14 조회 4,554
13-03-08 조회 4,155
13-03-03 조회 4,571
13-02-24 조회 4,999
13-02-21 조회 4,775
13-02-19 조회 4,797