Delphi PHP 파일 주석 표시 및 사양 요약의 리소스 파일

PHP 주석 태그
@access
사용 범위: 클래스, 함수, var, 정의, 모듈
이 태그는 키워드의 액세스 권한을 나타내는 데 사용됩니다: 개인, 공개 또는 보호
@author
저작자 표시
@copyright
사용 범위: 클래스, 함수, var, 정의, 모듈, 사용
저작권 정보 표시
@deprecated
사용 범위: 클래스, 함수, var, 정의 , module, constent, global, include
사용하지 않거나 더 이상 사용되지 않는 키워드를 나타냅니다.
@example
이 태그는 파일 콘텐츠를 구문 분석하고 강조 표시하는 데 사용됩니다. Phpdoc은
@const
범위 사용: 정의
PHP에서 정의의 상수를 나타내는 데 사용됩니다
@final
범위 사용 : class ,function,var
은 키워드가 최종 클래스, 메서드 또는 속성이며 파생 및 수정이 금지됨을 나타냅니다.
@filesource
이 태그가 현재 구문 분석된 PHP 파일의 내용을 직접 읽고 표시한다는 점을 제외하면 예제와 유사합니다.
@global
이 함수에서 참조되는 전역 변수를 나타냅니다.
@ingore
는 문서에서 지정된 키워드를 무시하는 데 사용됩니다.
@license
는 html 태그의 <와 동일합니다. ;a> 먼저 URL을 입력한 다음 표시할 콘텐츠를 입력하세요.
예를 들어 Baidu
는 다음과 같이 쓸 수 있습니다. @license http://www.baidu.com Baidu
@link
라이센스
와 유사하지만
@name
링크를 통해 문서의 모든 키워드를 가리킬 수도 있습니다. 키워드 지정 별명.
@package
사용 범위: 페이지 레벨 -> 정의, 함수, 포함
클래스 레벨 ->class, var, 메소드
는 하나 또는 여러 개의 키워드를 논리적으로 결합하는 데 사용됩니다. .
@abstrcut
현재 클래스가 추상 클래스임을 나타냅니다.
@param
함수의 매개변수를 지정합니다
@return
메서드나 함수의 반환 포인터를 지정합니다
@static
관전자가 정적임을 나타냅니다.
@var
변수 유형 표시
@version
버전 정보 표시
@todo
개선해야 할 부분이나 구현하지 말아야 할 부분 표시
@throws
다음을 표시 이 함수는 오류 예외가 발생하거나 극단적인 상황이 발생할 수 있습니다.
일반적인 문서 태그는 각 줄의 시작 부분에 @로 표시되어야 합니다. 또한, 다음과 같은 여러 가지를 포함하는 {@}로 표시되는 인라인 태그도 있습니다. 유형:
{@link}
사용법은 @link와 동일
{@source}
함수나 메소드의 내용 표시
댓글 사양
a.
/**
* 주석 내용
*/
형식은
b입니다. 전역 변수를 참조하는 함수의 경우 glboal 태그를 사용해야 합니다.
c. 변수의 경우 해당 유형은 var(int, string, bool...)로 표시되어야 합니다.
d. 함수는 param 및 반환 태그를 통해 매개변수와 반환 값을 나타내야 합니다. 2회 또는 2회 이상 사용된 키워드의 경우 중복되는 것은 ingore를 통해 무시하고 하나만 유지해야 합니다
f. 다른 함수나 클래스가 호출되는 경우에는 link 또는 기타 태그를 사용하여 해당 항목으로 연결해야 합니다. 문서를 쉽게 읽을 수 있도록 하는 부분입니다.
g. 코드 가독성을 높이기 위해 필요한 경우 문서화되지 않은 주석을 사용하세요.
h. 가능하면 문장보다는 문구를 사용하여 설명 내용을 간결하고 명확하게 유지하세요.
i. 전역 변수, 정적 변수 및 상수는 해당 태그로 선언되어야 합니다.
위 내용은 델파이의 리소스 파일 내용을 포함하여 델파이의 리소스 파일 요약, PHP 파일 주석 표시 및 사양을 소개하고 있으며, PHP 튜토리얼에 관심이 있는 친구들에게 도움이 되기를 바랍니다.