PHP

[phpDocumentor]@todo

rairen 2023. 12. 6. 11:44

원문

https://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.todo.pkg.html

 

@todo

@todo Document changes that will be made in the future Gregory Beaver Copyright 2002, Gregory Beaver (phpDocumentor 1.0+) @todo information string [unspecified format] DescriptionUse @todo to document planned changes to an element that have not been implem

manual.phpdoc.org

 

@todo

향후 발생할 변경 사항을 문서화합니다.

설명

구현되지 않은 요소에 대한 계획된 변경 사항을 문서화하려면 @todo를 사용하세요. phpDocumentor는 정보 문자열을 변경되지 않은 상태로 표시합니다.

@todo 태그는 문서화할 수 있는 거의 모든 요소(전역 변수, 상수, 함수, 정의, 클래스, 변수, 메소드, 페이지)에 대한 향후 변경 사항을 문서화하는 데 사용될 수 있습니다. v1.3.0부터 @todo는 더 이상 "include" 요소에 사용할 수 없습니다.

예시

/**
 * 페이지 수준 DocBlock
 *  @package  미완성
 *  @todo 이 페이지의 기능을 완료합니다.
 */
/**
 * 함수 데이터함수
 *  @todo  뭔가를 하게 만들어 보세요
 */
function  datafunction ( )
{
	// do something...
}
반응형