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건
+
제목 글쓴이 날짜 조회
15-12-13 조회 2,530
15-12-13 조회 2,945
15-12-11 조회 2,606
15-12-11 조회 2,566
15-12-11 조회 2,570
15-12-10 조회 2,528
15-12-10 조회 2,587
15-12-10 조회 2,560
15-12-03 조회 3,203
15-12-03 조회 2,718
15-11-25 조회 2,800
15-11-09 조회 3,209
15-11-04 조회 2,971
15-06-09 조회 4,095
15-05-06 조회 5,093
15-03-28 조회 4,576
14-12-05 조회 4,999
14-10-25 조회 5,097
14-10-13 조회 4,273
14-10-03 조회 6,262
14-09-19 조회 4,964
14-09-18 조회 4,050
14-09-13 조회 4,615
14-09-03 조회 5,603
14-08-26 조회 4,210
14-08-26 조회 4,014
14-08-26 조회 3,979
14-08-11 조회 6,506
14-08-06 조회 4,126
14-08-06 조회 3,724
14-08-06 조회 3,938
14-08-01 조회 6,306
14-08-01 조회 3,843
14-07-30 조회 4,443
14-06-28 조회 5,167
14-06-28 조회 4,438
14-05-11 조회 4,592
14-05-09 조회 4,950
14-05-09 조회 7,713
14-04-30 조회 4,336
14-04-27 조회 4,197
14-04-25 조회 4,900
14-04-21 조회 3,878
14-04-21 조회 5,006
14-04-10 조회 4,604
14-04-01 조회 6,158
14-03-03 조회 3,533
14-02-25 조회 5,922
14-02-14 조회 5,196
14-02-13 조회 4,953
14-01-03 조회 4,445
13-12-06 조회 3,767
13-11-22 조회 5,522
13-11-18 조회 4,029
13-10-02 조회 4,448
13-10-02 조회 3,698
13-10-02 조회 3,962
13-10-02 조회 3,817
13-10-02 조회 4,183
13-09-16 조회 8,032
13-09-16 조회 5,397
13-08-18 조회 5,429
13-07-11 조회 4,111
13-07-10 조회 4,694
13-07-09 조회 4,732
13-07-09 조회 4,988
13-07-04 조회 4,487
13-07-04 조회 4,125
13-07-04 조회 4,239
13-07-01 조회 4,727
13-07-01 조회 4,560
13-07-01 조회 6,835
13-06-23 조회 4,382
13-06-05 조회 3,629
13-05-29 조회 4,870
13-05-10 조회 4,276
13-04-05 조회 4,898
13-04-05 조회 6,586
13-04-05 조회 1.1만
13-04-05 조회 7,181
13-04-05 조회 6,567
13-03-31 조회 5,839
13-03-31 조회 4,166
13-03-28 조회 4,527
13-03-28 조회 6,724
13-03-28 조회 9,207
13-03-28 조회 4,338
13-03-24 조회 3,954
13-03-21 조회 4,631
13-03-21 조회 1.8만
13-03-14 조회 3,937
13-03-10 조회 4,747
13-03-10 조회 4,506
13-03-10 조회 4,207
13-03-08 조회 5,264
13-03-08 조회 4,370
13-03-03 조회 5,026
13-03-03 조회 7,480
13-03-03 조회 4,221
13-03-03 조회 1.1만