T

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

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


기본적인 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
*/
여러명이서 작업 하다보니 필요성이 생기더라구요 ㅎㅎ
혼자 하면 필요한 정보만 적어 두는데 ㅎㅎ
여러명... 부럽군요ㅠ 전 디자인 빼고는 혼자서 다 해야되는데ㅠㅠ
ㅠ.ㅠ
2014-07-29 (화) 14:24:02
개인적인 생각으론,
그냥 막그냥 확그냥 ..... 적어 두는게 최고인듯 합니다.

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

프로그램

8,188건
+
제목 글쓴이 날짜 조회
12-08-29 조회 3,925
12-08-07 조회 3,601
12-08-03 조회 3,506
12-07-31 조회 3,619
12-07-30 조회 3,578
12-07-16 조회 3,790
12-07-15 조회 3,498
12-07-07 조회 3,489
12-07-06 조회 3,612
12-07-03 조회 3,637
12-06-29 조회 3,230
12-06-22 조회 3,593
12-06-17 조회 3,717
12-05-21 조회 3,777
12-05-02 조회 3,359
12-05-02 조회 4,153
12-05-02 조회 3,265
12-04-30 조회 3,430
12-04-30 조회 3,131
12-03-17 조회 3,960
12-03-10 조회 3,341
12-03-08 조회 3,765
12-03-03 조회 3,519
12-02-27 조회 4,933
12-02-17 조회 4,283
12-02-16 조회 4,446
12-02-03 조회 3,263
12-01-31 조회 3,025
12-01-24 조회 3,078
12-01-17 조회 3,834
12-01-05 조회 3,388
11-12-30 조회 3,011
11-12-23 조회 4,632
11-12-08 조회 3,375
11-12-07 조회 4,354
11-11-27 조회 3,772
11-11-25 조회 4,115
11-11-23 조회 3,507
11-11-22 조회 3,451
11-11-09 조회 3,180
11-10-23 조회 3,085
11-10-19 조회 3,057
11-10-08 조회 2,763
11-10-04 조회 2,776
11-10-04 조회 5,218
11-09-01 조회 4,278
11-08-13 조회 2,450
11-08-06 조회 3,142
11-07-11 조회 3,542
11-06-27 조회 2,910
11-06-21 조회 2,554
11-06-13 조회 2,356
11-06-07 조회 2,375
11-05-26 조회 2,369
11-04-20 조회 2,679
11-03-21 조회 2,767
11-03-18 조회 2,464
11-03-11 조회 2,502
11-02-07 조회 2,323
11-01-18 조회 2,640
11-01-12 조회 2,363
11-01-06 조회 2,481
10-12-10 조회 2,743
10-12-09 조회 2,412
10-12-08 조회 4,995
10-11-29 조회 2,536
10-11-28 조회 2,742
10-11-28 조회 2,591
10-11-19 조회 2,781
10-11-04 조회 2,677
10-10-21 조회 2,387
10-10-19 조회 3,339
10-10-12 조회 2,660
10-10-07 조회 2,487
10-09-30 조회 3,445
10-09-17 조회 3,843
10-09-17 조회 3,809
10-05-31 조회 3,475
09-12-31 조회 3,623
09-07-23 조회 4,936
08-09-16 조회 3,175
08-09-06 조회 2,896
08-09-04 조회 3,330
08-08-16 조회 4,380
08-08-15 조회 3,251
08-08-14 조회 4,462
08-08-12 조회 3,826
08-07-23 조회 2,751
08-07-10 조회 3,691
08-07-04 조회 2,914
08-06-27 조회 7,568
08-06-19 조회 4,855
08-05-27 조회 5,471
08-05-25 조회 5,297
08-05-23 조회 3,371
08-05-23 조회 4,509
08-05-21 조회 4,892
08-05-20 조회 4,015
08-05-20 조회 3,251
08-04-18 조회 4,285