모든 PHPer가 마스터해야 할 댓글 태그!

                                                       

추천: "PHP 비디오 튜토리얼"

머리말

댓글 태그는 코드 댓글에서 매우 중요한 역할을 합니다. 좋은 댓글 태그는 프로그래밍 과정에서 더 좋고 편안한 경험을 제공할 수 있습니다. 이 태그들을 정리해서 사진과 텍스트 형태로 보여드릴 예정입니다. 한편으로는 이 주석 태그를 요약하고 정리하고 싶기도 하고, 다른 한편으로는 주석 태그를 더 잘 이해하실 수 있기를 바라기도 합니다

모두가 아름다운 코드를 작성하고 싶어할 수도 있습니다. 아마도 당신은 아름다운 코드에서 단 하나의 태그만 떨어져 있을 것입니다.

추상 클래스 변수 및 메소드

@access@authorZhang Sanzhangsan@163.com@copyright이름 시간문서 저작권 정보@deprecatedversion 문서 메서드에서 더 이상 사용되지 않음 @deprec/path/to/example문서의 메소드에 의해 발생한 예외의 경우 @throws를 참조할 수도 있습니다.Type: $globalvarname문서에 지정된 키워드 무시개발팀 내부 정보@linkURL 라이센스와 유사하지만 괜찮습니다. 링크를 통해 문서에서 더 자세한 정보를 찾아보세요변수 별칭@magic캡슐화된 패키지 이름예: $username 사용자 이름@returnsuch bool 반환으로 함수 반환 결과 설명, 일반적으로 void(빈 반환 결과) 함수@see예: Class Login()파일과 관련된 모든 요소(페이지를 포함한 전역 변수, 클래스, 함수, 정의, 메소드, 변수). @sinceversion문서의 어떤 부분이 변경되었는지 기록@staticat 클래스 및 함수에 사용되는 정적 변수@subpackage@throws@todo@vartype문서의 변수 및 해당 유형문서, 클래스 및 함수의 버전 정보

public, private 또는 protected

문서의 액세스 및 사용 권한은 문서가 보호된다는 것을 나타냅니다.

문서 작성자

Same as @deprecated

@example

문서 외부에 저장된 예제 파일의 위치입니다.

@Exception

@global

전역 변수 및 관련 메소드와 함수 문서

@ignore

@internal

@name

변수 별칭 지정

phpdoc.de 호환성

@ package

관련 클래스 및 함수 그룹으로 패키지된 패키지 이름

@param

변수 의미 주석

정적 클래스, 메서드 기록

@staticvar

subversion

특정 메서드에서 발생한 예외

다음이 있는 지역을 나타냅니다. 파일이 불완전하거나 개선이 필요합니다

@version

사실 위의 내용 중 대부분은 파일 및 클래스 생성 시 추가해 주어야 하는 부분이 대부분입니다. 오늘은 흔히 사용되는 태그를 중심으로 설명하겠습니다.

@param

Description

매개변수, 함수 및 메서드 주석의 태그에 사용됨
Format @param [Type] [name] [<description>]</description>@param [Type] [name] [<description>]</description>
例如@param string title 文章标题

代码举例

@return

说明

返回值
格式@return [类型] []]
例如@return array 结果数组

代码举例

@deprecated

说明

不建议使用的、已过期的、将被删除的
格式@deprecated [] []
例如@deprecated 1.0.0 新版本将不再包含此函数
如果它是被其他方法所取代了，建议添加@see标记

代码举例

@see

说明

参考，类似@link，可与@deprecated联动
格式@see [url或完整方法名] []
例如@see yiibasedb::tableName() 旧方法table_name已弃用，请使用此方法替代

代码举例

@link

说明

链接，可用于辅助说明、引用文档等
格式@link [url] []
例如@link http://g.cn 不懂滚去问谷歌，别来烦我

代码举例

@link&@see区别

-	@see	@link
外部链接	√	√
内部程序	√	X

@var

说明

变量
格式@var [类型] [变量名] []
例如@var int id 用户id

变量列表

变量类型	说明
string	字符串
integer/int	number/int类型
boolean/bool	false/true
float/double	number/浮点数
object	对象实例
specifiedType	指定类
mixed	任意类型
array/specifiedType[]	数组，可以指定成指定类型的数组
resource	文件资源类型
void	无返回值
null	-
callable	可执行的回调函数
function	不一定能执行的方法
self/$this	当前实例

代码举例

1、在方法外的变量定义

2、在方法内的变量定义

@throws

说明

可能会抛出的错误类型
格式@throws [类型] []
例如@throws Exception예: @param 문자열 제목 기사 제목

코드 예

@return

Description

Return value🎜Format @return [Type] []]🎜예: @return 배열 결과 배열🎜🎜코드 예🎜🎜🎜🎜@deprecated🎜 🎜Description🎜 🎜권장되지 않고 만료되어 삭제될 형식🎜@deprecated [<version number>] [<description>]</description></version>🎜예: @deprecated 새 버전 1.0. 0에는 더 이상 이 기능이 포함되지 않습니다.🎜다른 방법으로 교체하는 경우 @see 태그를 추가하는 것이 좋습니다🎜🎜코드 예시🎜🎜🎜🎜@see🎜🎜Explanation🎜🎜Reference , @와 유사 링크는 @deprecated로 연결될 수 있습니다🎜Format @see [url 또는 전체 메소드 이름] []🎜예: @see yiibasedb::tableName() 이전 메소드 table_name은 더 이상 사용되지 않습니다. 대신 이 메소드를 사용하세요 🎜 🎜코드 예제🎜🎜🎜 🎜@link🎜🎜Description🎜🎜링크는 보조 지침, 참조 문서 등에 사용할 수 있습니다.🎜형식 @link [url] [<description>]</description>🎜예: @link http://g.cn 이해가 안되면 구글에 가서 물어보세요. 귀찮게 하지 마세요.🎜🎜코드 예제🎜🎜🎜🎜@link&@see Difference🎜-

@see	@link
외부 링크	√ td>	√
내부 프로그램	√	X

🎜@var🎜🎜Description🎜🎜Variable🎜Format @var [type] [변수 이름] [<description>]</description>🎜예: @var int id 사용자 ID🎜🎜변수 목록🎜 tr> td>

변수 유형	설명
문자열	문자열
정수/정수	숫자/정수 유형
부울/부울	false/true
float/double	숫자/ 부동 소수점
객체	객체 인스턴스
지정된 유형	지정된 클래스
혼합	모든 유형
배열/지정 유형[]	배열, 예 지정된 유형의 배열을 지정합니다.
리소스	파일 리소스 유형
void	반환 값 없음
null	-
호출 가능	실행 가능한 콜백 함수
함수	실행할 수 없는 메서드
self/ $this	현재 인스턴스

🎜코드 예🎜🎜1. 메소드 외부의 변수 정의🎜🎜2. 메소드 내의 변수 정의🎜🎜🎜🎜@throws🎜🎜 설명🎜🎜유형 발생할 수 있는 오류🎜형식 @throws [유형] [<description>]</description>🎜예: @throws Exception🎜🎜🎜🎜                                             🎜🎜 🎜🎜🎜

위 내용은 모든 PHPer가 마스터해야 할 댓글 태그!의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!