phpdoc : 상수를 문서화하는 올바른 방법은 무엇입니까

Question

define()을 사용하여 정의 된 상수를 문서화하는 적절한 방법이 있습니까? @ var는 실제로 이해가되지 않습니다. 내가 생각할 수있는 유일한 것은 태그를 생략하고 PHPdoc 주석에 설명을 작성하는 것입니다.

Answer 1

phpDocumentor 인식 또는 @const 태그를 사용하지 않습니다. phpDocumentor는 코드에서 "define"키워드를 볼 때 상수를 인식합니다. 그 출력 템플릿은 상수로 나열된 출력 문서의 모든 상수를 보여줍니다. 상수의 docblock에 필요한 유일한 것은 설명입니다. 비록 다른 많은 "표준"태그가 필요하다면 사용할 수 있습니다. [1].

[1] - http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_elements.pkg.html#procedural.define

Answer 2

@const을 사용하십시오.

/** 
    * @const FOO Bar 
    */ 
define('FOO', 'Bar'); 

Documentation는 (미안 해요, 난 찾을 수있는 유일한 문서는 독일어입니다.)

Answer 3

당신은 실제로 Github PHP Documentation를 참조 @type을 사용하고 싶습니다.