>  기사  >  백엔드 개발  >  PHP 주석 사양

PHP 주석 사양

高洛峰
高洛峰원래의
2016-12-01 09:42:36982검색

@access
사용 범위: 클래스, 함수, var, 정의, 모듈
이 태그는 키워드의 액세스 권한을 나타내는 데 사용됩니다: private, public 또는 protected
@author
작성자
@copyright
사용 범위: 클래스, 함수, var, 정의, 모듈, 사용
저작권 정보 표시
@deprecated
사용 범위: 클래스, 함수, var, 정의, 모듈, constent , global, include
사용되지 않거나 더 이상 사용되지 않는 키워드를 나타냅니다.
@example
이 태그는 파일 콘텐츠를 구문 분석하고 강조 표시하는 데 사용됩니다. Phpdoc은
@const
태그에 지정된 파일 경로에서 파일 내용을 읽으려고 시도합니다. 사용 범위: 정의
php에 정의된 상수를 지정하는 데 사용됩니다.
@final
사용 범위: class ,function,var
은 키워드가 최종 클래스, 메서드 또는 속성이며 파생 및 수정이 금지됨을 나타냅니다.
@filesource
이 태그가 현재 구문 분석된 PHP 파일의 내용을 직접 읽고 표시한다는 점을 제외하면 예제와 유사합니다.
@global
이 함수에서 참조되는 전역 변수를 나타냅니다.
@ingore
는 문서에서 지정된 키워드를 무시하는 데 사용됩니다.
@license
는 html 태그의 <와 동일합니다. ;a> 먼저 URL을 입력한 다음 표시할 콘텐츠를 입력하세요.
예를 들어 .baidu.com Baidu
@link
는 라이센스
와 유사하지만 링크
@name
을 통해 문서의 모든 키워드를 가리켜 키워드에 대한 별칭을 지정할 수도 있습니다.
@package
사용 범위: 페이지 레벨 -> 정의, 함수, 포함
클래스 레벨 ->class, var, 메소드
는 하나 또는 여러 개의 키워드를 논리적으로 결합하는 데 사용됩니다.
@abstrcut
현재 클래스가 추상 클래스임을 나타냅니다.
@param
함수의 매개변수를 지정합니다.
@return
메서드나 함수의 반환 포인터를 지정합니다.
@static
관전자가 정적임을 나타냅니다.
@var
변수 유형 지정
@version
버전 정보 지정
@todo
개선해야 할 부분이나 구현하지 말아야 할 부분 지정
@throws
이 함수가 오류 예외를 발생시킬 수 있음을 나타냅니다. 극히 드뭅니다
위에서 언급한 것처럼 일반 문서 태그는 각 줄의 시작 부분에 @를 표시해야 합니다. 또한 {@} 표현식을 사용하여 인라인 태그라는 태그도 있습니다. 다음을 포함하세요:
{@link}
사용법은 @link와 동일합니다
{@source}
함수 또는 메서드의 내용 표시