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

Terrorboy

프로필 보기 이 회원 글보기

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

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

게시글 목록

번호	제목	글쓴이	조회	날짜
20097	PHP User Management 관련 입니다.	혀니천사	362	9년 전
20095	웹서버 LEMP(ubuntu14.04 + nginx + mysql + php-fpm + memcached) 스택 설치방법 소개 1	gilynh	539	9년 전
20093	PHP 관리자 및 회원의 페이지 접근 권한 간단구현 입니다. 1	혀니천사	474	9년 전
20092	PHP [서버운영] 아파치로그] sql로 바로 저장 입니다.	혀니천사	355	9년 전
20091	PHP [서버운영] 아파치로그] 보기좋고 파싱하기 좋은 통합로그 입니다.	혀니천사	359	9년 전
20089	PHP (win) xdebug와 xampp 사용하기 입니다. 1	혀니천사	412	9년 전
20086	PHP 계정별 register_global 설정 입니다. 2	혀니천사	405	9년 전
20085	PHP apache log처리에 대해서 입니다.	혀니천사	304	9년 전
20084	PHP 이름기반 가상호스트 설정관련 입니다.	혀니천사	309	9년 전
20083	PHP exif 익스텐션 실행이 안되는 경우 입니다.	혀니천사	257	9년 전
20082	PHP 타겟(target) 쓰는 법 입니다.	혀니천사	309	9년 전
28358	input에 링크를 걸려고 하는데;; 2	ABC디자인	709	9년 전
20081	PHP 파일이름의 확장자로 파일 종류를 확인하는 함수 입니다.	혀니천사	328	9년 전
20079	PHP 이미지 없는 라운드테이블 만들기 입니다. 1	혀니천사	429	9년 전
20078	PHP 문자셋 인코딩 바꾸는 팁 입니다.	혀니천사	347	9년 전
20077	PHP 타도메인간 쿠키 공유하기 입니다	혀니천사	545	9년 전
20076	PHP apache mod_rewrite 설치시 팁 입니다	혀니천사	368	9년 전
20075	PHP 본문에 주민등록번호가 포함되면 경고 알려주기 입니다.	혀니천사	301	9년 전
20074	PHP 입력내용중의 일부만 보여주고 x 표시 할때 입니다.	혀니천사	330	9년 전
20073	PHP php환경 변수 출력 입니다.	혀니천사	349	9년 전
20072	PHP PHP팁 (보안 등) 입니다.	혀니천사	474	9년 전
20071	PHP 문자열 자르는 함수 입니다.	혀니천사	420	9년 전
20070	PHP 게시판에서 컨텐츠중 이미지 사이즈를 조정 입니다.	혀니천사	271	9년 전
20069	PHP 파일 업로드 시 html에서 용량 제어하기 입니다.	혀니천사	331	9년 전
8148	저작권 폰트? 23	프로그래머7	1,294	10년 전
20057	정규표현식 파싱 예제입니다. 11	유창화	1,187	10년 전
8141	자바스크립트로 트위터 트윗을 따오고 싶어요! 6	zahir1312	725	10년 전
24669	예전에 봤던 PPT만들기 팁 공유하고싶어서요.	ABC디자인	1,332	10년 전
20056	웹서버 리눅스 특정 명령어 실행 권한 주기	컴프	386	10년 전
8138	PC로 스마트폰 터치제어하기가 가능한가요? 2	민일기	815	10년 전
28353	파이어폭스 본고딕 웹폰트 깨짐.. 4	이온디	1,026	10년 전
20055	jQuery Simple Carousel (Sliding Banner)	자루스	488	10년 전
20054	jQuery CSS3 - transition, transform을 이용한 element effect!	자루스	436	10년 전
20053	PHP 비 전문가를 위한 XMLHttpRequest 활용 소개 입니다.	혀니천사	433	10년 전
20052	PHP 디렉토리내의 모든 원소의 소유권, 그룹, 퍼미션 정보 가져와서 저장하기 입니다.	혀니천사	284	10년 전
20051	PHP httpd.conf 파일 완벽 가이드 입니다.	혀니천사	437	10년 전
20050	JavaScript 지난 시간 경과시간 페이스북 sns 처럼 보여주기 javascript 버전	들불	460	10년 전
20047	PHP [Instagram] 해시태그 검색 이미지 얻어오는 방법 2	해피정	982	10년 전
20046	PHP php환경맞춤 부분 입니다.	혀니천사	390	10년 전
20045	PHP 프레임 새로고침할 때 페이지 유지하기 입니다.	혀니천사	459	10년 전
20044	PHP 접속자의 브라우져와 OS정보를 알려주는 함수 입니다.	혀니천사	439	10년 전
8111	구매대행 쇼핑몰 제작의뢰. 26	fbastore	1,368	10년 전
20043	PHP 웹호스팅해서 사용시 fopen을 사용하지 못할 경우 해결법입니다.	혀니천사	472	10년 전
20042	PHP zend 설치하기 (php.ini) 에서 안보일때 해결법 입니다.	혀니천사	330	10년 전
20040	PHP 아파치 무단링크 막기 입니다. 1	혀니천사	482	10년 전
20039	JavaScript 구글 맞춤검색 설정 방법, google custom search	위토즈	499	10년 전
20037	PHP php in_array 사용법 배열값 확인하기 1	컴프	571	10년 전
20036	PHP ob_start callback에 대한 설명	컴프	369	10년 전
20035	PHP call_user_func 함수 재정의	컴프	431	10년 전
20027	MySQL 1000만건 게시판에 도전합니다. 두번째 7	리자	832	10년 전
8107	제로보드에서 그누보드 변경방법? 3	심슨아	766	10년 전
31022	기타 ie 와 크롬 폰트 부분해결할 수 있는건지좀 알려주시면 감사드립니다. 1	바른통남	739	10년 전
20026	MySQL Join 을 이용한 delete	브이룩	296	10년 전
20025	PHP 정규식 (Regular Expression Functions) 입니다.	혀니천사	382	10년 전
20024	PHP Apache 설치후 httpd.conf 설정	혀니천사	387	10년 전
20023	PHP 미리 정의된 변수들 입니다.	혀니천사	319	10년 전
28350	파일다운 링크에관해 질문드립니다 ㅠ_ㅠ도와주세요 2	심슨아	594	10년 전
20022	PHP array_rand 관련 입니다.	혀니천사	310	10년 전
20018	MySQL 1000만건 게시판에 도전합니다. 첫번째 3	리자	653	10년 전
20017	MySQL select 해서 바로 insert하기	브이룩	313	10년 전
8099	사파리에서는 두개 이상의 같은 이름 radio는 안 먹네요. 7	자루스	604	10년 전
20016	MySQL 필드 내용에서 특정문자열을 기준으로 문자열 자르기	띠아블	310	10년 전
20013	PHP PHP최근메뉴얼(도움말)파일입니다 2	혀니천사	534	10년 전
8090	모바일사이트 앱등록 방법 8	도담도담	1,107	10년 전
20012	PHP 시스템 정보를 알아볼 수 있는 방법입니다.	혀니천사	431	10년 전
20010	PHP number_format 시 빈값 예외처리 1	김득신	452	10년 전
20009	웹서버 Could not reliably determine the server's fully qualified domain name	잘살아보자	308	10년 전
19998	PHP 텔레그램 푸쉬 봇 10	foxrain	1,379	10년 전
28348	SK 공시지원금 홈페이지 자동연동 API 1	Tosea	1,010	10년 전
28347	angularjs 수정작업 및 스크립트 작업 가능 하신분 계신가요?	페페오	608	10년 전
19997	OS 짧은 주소 만들기, htaccess RewriteRule 리다이렉션	잘살아보자	566	10년 전
19996	OS 파일분할 분할압축 해제	잘살아보자	378	10년 전
19995	웹서버 리눅스백그라운드실행	잘살아보자	494	10년 전
19993	PHP 로컬에서 자바스크립트 HTML 소스 가져오기 1	혀니천사	1,157	10년 전
8087	<초보분들을 위한 개념> CSS란 ? 2	ITBANK	1,198	10년 전
8065	오픈마켓, 개발 3년차에게 가능한 일인지? 21	승희아빠	1,866	10년 전
19990	jQuery JQuery 이미지 lazyload 플러그인입니다. 2	DMAN	958	10년 전
8063	g4->g5로 업데이트후 구글에서 검색노출 저조되는현상.. 1	레이파니	826	10년 전
8056	오픈마켓 오픈소스 구할수 있을까요? 6	승희아빠	1,327	10년 전
19989	기타 printf함수를 이용하여 문자 출력	잘살아보자	452	10년 전
19988	기타 printf함수를 이용하여 실수형 데이터 출력하기	잘살아보자	420	10년 전
19987	기타 printf함수를 이용하여 정수값 출력하기	잘살아보자	417	10년 전
19986	기타 정수값으로문자출력 putchar	잘살아보자	407	10년 전
19985	기타 c언어 기초강의 - 한문자 출력 명령어 putchar	잘살아보자	487	10년 전
19984	기타 C언어기초강의 - puts로 문자열 출력	잘살아보자	613	10년 전
19983	MySQL [MySQL] csv 파일을 직접 MySQL 테이블로 Import 하는 방법 (대용량 파일 import 팁)	잘살아보자	851	10년 전
19982	MySQL mysql에서 boolean 타입 사용하기	잘살아보자	381	10년 전
8054	답글, 댓글 로직 1	리자	908	10년 전
19981	jQuery jquery 플러그인: rolVideo.min.js 공개하였습니다.	starbros	777	10년 전
19980	웹서버 [리눅스] 사양 알아보기 (메모리, CPU, HDD, 비트, 네트워크)	잘살아보자	587	10년 전
19979	MySQL mysqladmin 상태 모니터링	잘살아보자	459	10년 전
19978	기타 리눅스 아파치 서버에 그누컨텐츠 설치하기	잘살아보자	426	10년 전
19977	웹서버 리눅스 프로세스 중단, 제거, 중지 - Kill	잘살아보자	478	10년 전
19976	웹서버 리눅스 프로세스 검사, 조회	잘살아보자	431	10년 전
19975	웹서버 리눅스에서 네트워크 상태 보기	잘살아보자	456	10년 전
19974	웹서버 리눅스 80 포트 방화벽 열기	잘살아보자	790	10년 전
19973	MySQL mysql 사용시 콘솔내에서 유용하게 사용할 수 있는 방법 몇가지	잘살아보자	377	10년 전
19972	MySQL Mysql Table 일괄 삭제 방법.	잘살아보자	473	10년 전
19971	MySQL Mysql 특정값 제외하고 Select 하기. Not IN	잘살아보자	635	10년 전
19970	MySQL mysql . update replace(치환) 방법 (mysql 팁)	잘살아보자	554	10년 전

이전 다음

3 4 5 6 7

전체 목록