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

Terrorboy

프로필 보기 이 회원 글보기

· 11년 전 · 조회 2179 2179 · 댓글 6 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개

뽁스

프로필 보기 이 회원 글보기

11년 전

http://ko.wiktionary.org/wiki/abstract
간략 설명을 적으면 될 듯 하네요.

전 패키지라 부를 정도의 작업을 안 해봐서 어떻게 쓰는지는 모르고 그냥 아래처럼 적습니다ㅎㅎ
/*
내맘대로 주석1
내맘대로 주석2
*/

Terrorboy

프로필 보기 이 회원 글보기

11년 전

여러명이서 작업 하다보니 필요성이 생기더라구요 ㅎㅎ
혼자 하면 필요한 정보만 적어 두는데 ㅎㅎ

뽁스

프로필 보기 이 회원 글보기

11년 전

여러명... 부럽군요ㅠ 전 디자인 빼고는 혼자서 다 해야되는데ㅠㅠ

Terrorboy

프로필 보기 이 회원 글보기

11년 전

ㅠ.ㅠ

검은여우

프로필 보기 이 회원 글보기

11년 전

개인적인 생각으론,
그냥 막그냥 확그냥 ..... 적어 두는게 최고인듯 합니다.

주석많이 적었다고 욕먹은적은 없으니 .... ㅎㅎ

Terrorboy

프로필 보기 이 회원 글보기

11년 전

그건 그렇죠 ㅎㅎㅎ
그런데 외국에서는 소스 다이어트/화이트 스페이스 가리는것이 많더라구요

게시글 목록

번호	제목	글쓴이	조회	날짜
8265	스크롤 소스 구합니다 2	북금곰	420	9년 전
20403	PHP 숫자를 한글표기로 바꾸기 입니다.	Angelos	606	9년 전
20402	Mobile Android,IOS 앱용 아이콘 템플릿 참고 사이트	인덱스웹	470	9년 전
20401	PHP 여러문장을 한번에 자동 줄바꿈 하기 입니다.	Angelos	537	9년 전
20400	웹서버 서버 동시접속자 설정 변경하기	인덱스웹	472	9년 전
8259	반응형웹 템플릿 좀 봐주세요. 5	아나이스	729	9년 전
20399	PHP 디렉토리의 모든 파일을 읽어 목록으로 만들기 입니다.	Angelos	458	9년 전
20398	PHP PHP 버전이 낮아 imagerotate() 함수가 없을때 대신 사용하는 함수	뿌하하	448	9년 전
8255	가운데 정렬좀 요~~~ 3	북금곰	383	9년 전
8249	시안 퍼블리쉬 해주신느분 있나요? 5	북금곰	493	9년 전
8246	부트스트랩은 어디서 받나요? 2	북금곰	428	9년 전
8242	소스구해요 3	북금곰	500	9년 전
20396	PHP 간단하게 자동으로 테이블 너비 조정하기 입니다. 1	Angelos	578	9년 전
8240	PHP MYSQL 장문 필드 검색 질문 입니다. 2	뜨거운형제들	365	9년 전
20395	PHP 문자열자르기 (문자별 다른 너비 해결)	PASKRAN	432	9년 전
20394	MySQL 테이블 복사 쿼리	서로웹	426	9년 전
31033	기타 많이들 사용하시는 Slider 에 대해서... 2	kiplayer	569	9년 전
28385	밀려요 2	북금곰	391	9년 전
20393	PHP 현재 접속중인 사용자 나타내기	Angelos	507	9년 전
28380	디스플라이 인라인이 안되요,, 4	북금곰	360	9년 전
20392	MySQL mysql select 후 update 하기	서로웹	408	9년 전
28377	노란색박스가 가운데로 오게하려면 어떻게 하나요? 2	북금곰	319	9년 전
20391	PHP 다른 페이지로 이동하는 방법 3가지 입니다.	Angelos	501	9년 전
20390	PHP 한글문자열 자르는 법 입니다.	Angelos	392	9년 전
20389	PHP mysql_query 전체 갯수 빨리 알아보기 입니다.	Angelos	398	9년 전
20388	PHP POST값 통째로 인코딩하기, 배열, iconv	서로웹	440	9년 전
20387	PHP 이메일주소 검사하기 입니다.	Angelos	394	9년 전
20386	웹서버 php 확장자 내 맘대로 바꾸기 입니다.	Angelos	393	9년 전
20385	PHP 문자열을 한 문자씩 나누어 출력하기 입니다.	Angelos	341	9년 전
20384	node.js Node js 게시판 프로젝트 소개합니다.	snshero	736	9년 전
20383	PHP pc 모바일 체크 1	서로웹	799	9년 전
20382	PHP 계정 사용량(용량) 확인	서로웹	768	9년 전
8238	어도비에서 만든 텍스트에디터 Brackets 1	띠아블	683	9년 전
20380	PHP textarea 입력한 엔터값 출력하기 1	서로웹	469	9년 전
20379	MySQL 소수점 반올림 버림	서로웹	666	9년 전
28376	html page 이동시 흰색 깜박임 없앨수 있나요??	분석	775	9년 전
28372	헤더영역 position: fixed 했는데 가로 스크롤이 안되네요 3	모두	462	9년 전
20378	jQuery jQuery version 1.9 이상에서 $.browser 사용하기	띠아블	758	9년 전
20377	PHP 에러 로그파일 생성하기	서로웹	720	9년 전
8235	CRM 고객관리 프로그램 2	별이님	1,114	9년 전
20375	PHP 간단한 특정 IP 차단하기 입니다. 1	혀니천사	721	9년 전
20374	PHP 다른 사이트의 내용을 자동으로 긁어오기 입니다.	혀니천사	918	9년 전
20373	PHP 후이즈검색 하기 입니다.	혀니천사	599	9년 전
20372	PHP 그래프 그리기 입니다.	혀니천사	701	9년 전
20371	JavaScript 자바스크립트로 구현한 number_format() 입니다.	혀니천사	485	9년 전
20370	JavaScript 금액 관련 숫자를 한글로 변환하기 입니다.	혀니천사	444	9년 전
28370	모니터 별 세로 해상도 채울 수 있나요? 1	지로쿨	574	9년 전
20369	PHP PHP 날짜 계산 관련 함수	서로웹	543	9년 전
28366	이제 3년되가는 퍼블리셔입니다. 3	분석	718	9년 전
20368	jQuery jQuery 1.x와 2.x 버전 동시에 사용하기	서로웹	435	9년 전
20367	PHP 요일, 시간마다 다른 CSS 제어하기 입니다.	혀니천사	518	9년 전
20366	PHP iframe내의 id셀렉터 입니다.	혀니천사	468	9년 전
20365	JavaScript 사업자 등록번호 검사하기 입니다.	혀니천사	413	9년 전
20364	PHP 폼전송을 통해서 페이지를 이동하기 입니다.	혀니천사	483	9년 전
20363	JavaScript 항상 같은곳에 광고창 만들기 입니다.	혀니천사	370	9년 전
20362	JavaScript 부메뉴 나오게 하기 입니다.	혀니천사	384	9년 전
20361	JavaScript 특정문자 제거하기 입니다.	혀니천사	352	9년 전
20360	JavaScript 휴대폰번호 검사 하기 입니다.	혀니천사	402	9년 전
20359	JavaScript 이미지 좌우로 이동 갤러리 입니다.	혀니천사	384	9년 전
8231	웹 html 에디터는 어떻게 구현하시나요? 3	o1o111	842	9년 전
20358	PHP 파일 확장자 검사 함수 입니다.	혀니천사	354	9년 전
20357	JavaScript 쉬운 replaceAll 입니다.	혀니천사	286	9년 전
20356	PHP 그누보드 최근 게시물 파싱하기 입니다.	혀니천사	549	9년 전
20355	PHP [알고리즘]퀵 정렬(Quick Sort)	슈와이	362	9년 전
20354	PHP php로 옥션 지마켓 11번가 쿠팡 위메프 등의 발주내역서 파일을	판도라g	389	9년 전
20353	PHP array_unique 배열중복값 제거	서로웹	340	9년 전
20352	JavaScript 콤보스타일 메뉴 입니다.	혀니천사	309	9년 전
20351	JavaScript 쿠키를 이용한 레이어 공지창 입니다.	혀니천사	270	9년 전
20350	JavaScript 효과있는 텍스트 틱커 입니다.	혀니천사	261	9년 전
20349	PHP [알고리즘]힙 정렬(Heap Sort)	슈와이	313	9년 전
20348	PHP HTTP 인증 하기 입니다.	혀니천사	329	9년 전
20347	JavaScript 외부 문서 불러오기 입니다.	혀니천사	270	9년 전
20346	JavaScript 지정한 날짜까지 New 이미지를 띄워주기 입니다.	혀니천사	215	9년 전
20345	MySQL Common MySQL Queries 다양한 MySQL 쿼리 예제	서로웹	328	9년 전
20344	JavaScript 메일 주소 검사하기 체크박스 입니다.	혀니천사	264	9년 전
20343	JavaScript 무단링크 금지하기 입니다.	혀니천사	293	9년 전
20342	PHP 간단하게 마우스,드래그,복사 등 막기 입니다.	혀니천사	316	9년 전
20341	MySQL DB백업 및 복원	서로웹	355	9년 전
20340	JavaScript 페이지가 다른 사이트의 프레임에 갇히는 것을 막기 입니다.	혀니천사	244	9년 전
20339	PHP 다른 사이트로 이동시 또는 창 닫을 시에 자동 로그아웃 하기 입니다.	혀니천사	285	9년 전
20338	PHP PHP에 MYSQL 와 자바스크립트 연동 예제 입니다.	혀니천사	354	9년 전
20337	jQuery input text 대문자만 받는 Jquery	서로웹	271	9년 전
20336	PHP 현재 페이지 URL 출력하기 입니다.	혀니천사	388	9년 전
20335	JavaScript 이미지 업로드와 미리보기 입니다.	혀니천사	323	9년 전
20334	JavaScript 배경음악 랜덤 재생 하기 입니다.	혀니천사	255	9년 전
20333	JavaScript css 지원 여부 확인해서 다른 페이지로 이동하기 입니다.	혀니천사	225	9년 전
20332	JavaScript 하부메뉴가 보였다가 숨겨졌다 하는 토글버튼 입니다.	혀니천사	275	9년 전
20331	JavaScript 개별 페이지에 인덱스로 거쳐 들어오게 하기 입니다.	혀니천사	223	9년 전
20330	JavaScript 랜덤으로 이미지 출력 되기 입니다.	혀니천사	257	9년 전
20329	JavaScript 사용자 해상도 알아내기 입니다.	혀니천사	284	9년 전
20328	JavaScript 붙여넣기 금지하기 입니다.	혀니천사	222	9년 전
20327	MySQL 대소문자 데이터 조회하기	서로웹	281	9년 전
20326	JavaScript 퇴장시 팝업창 한번한 띄우기 입니다.	혀니천사	238	9년 전
20325	PHP www 주소 리다이렉션 시켜주기 입니다.	혀니천사	347	9년 전
20324	PHP 신문 기사를 긁어오기 입니다. 1	혀니천사	441	9년 전
20323	JavaScript 시도, 구군, 동 주소 select	슈와이	391	9년 전
20322	MySQL 커리로 DB 테이블 명세서 출력하기	서로웹	350	9년 전
20321	JavaScript 브라우저 해상도 구분없는 절대 x,y 좌표 값 구하기 입니다	혀니천사	304	9년 전
20320	PHP rss 읽어오기 입니다.	혀니천사	351	9년 전
20319	JavaScript 자바스크립트로 Ajax 효과내기 입니다.	혀니천사	291	9년 전

이전 다음

1 2 3 4

전체 목록