상수에 대한 PHPDocs를 작성하는 올바른 방법은 무엇입니까?

상수에 대한 PHPDocs를 작성하는 올바른 방법은 무엇입니까?

---

이 코드가 있습니다.

/**
 * Days to parse
 * @var int
 */
const DAYS_TO_PARSE = 10;
...

@var상수에 대해 사용하는 것이 정확 하다고 생각 하지 않으며 @constantPHPDoc 태그 가 표시되지 않습니다 . 이를 수행하는 올바른 방법은 무엇입니까?

---

phpDoc으로 가져 오려면 다음을 사용하십시오.

@const THING

일반적인 구조 :

@const[ant] label [description]

---

PHP-FIG는 @var상수에 대한 사용 을 제안 합니다.

7.22. @var

@var태그를 사용하여 다음 "구조 요소"의 "유형"을 문서화 할 수 있습니다 .

• 상수, 클래스 및 전역 범위
• 속성
• 전역 및 로컬 범위의 변수

통사론

@var ["Type"] [element_name] [<description>]

---

@const정답 이 아닙니다 .

• 레거시 phpDocumentor 문서의 일부가 아닙니다 : http://manual.phpdoc.org/HTMLframesConverter/default/
• 현재 phpDocumentor 문서의 일부가 아닙니다 : http://www.phpdoc.org/docs/latest/index.html
• Wikipedia의 태그 목록에 없습니다 : http://en.wikipedia.org/wiki/PHPDoc#Tags
• PHP-FIG 초안 PSR에 나열되어 있지 않습니다 : https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md#7-tags

목록에있는 유일한 "공식"장소는 phpdoc.de이지만 사양은 1.0 베타로만 만들어졌고 사이트에는 이전에 사용한 적이없는 @brotherand와 같은 태그도 포함되어 @sister있으므로 해당 사이트에 대한 전반적인 신뢰도를 얻었습니다. ;-) 사실상 표준은 항상 phpDoc.org였습니다.

요컨대, 일부 비공식 표준에서 언급하더라도 문서 생성자가 지원하지 않으면 사용할 가치가 없습니다.

@var 맞다 지금은 PSR (위 목록의 마지막 링크)이 초안에서 벗어 났고 phpDocumentor, Doxygen, APIGen 및 기타 사용자가 PHPDoc을 이해하는 기반이되면 다음 @type의 후속 작업이 정확합니다.@var.

---

Netbeans를 사용합니다. 이 형식을 사용할 때 전역 및 클래스 상수에 대해 phpDoc을 구문 분석합니다.

/** @const Global constant description */
define('MY_CONST', 10);

class MyClass
{
    /** @const Class constant description */
    const MY_CONST = 10;
}

---

다음 제안 은 공식 문서 구문을 존중 합니다 .

class Foo
{
    const
        /**
         * @var string Should contain a description
         */
        MY_CONST1 = "1",
        /**
         * @var string Should contain a description
         */
        MY_CONST2 = "2";

}

---

유형은 항상 다음과 같기 때문에 상수 유형에 주석을 달 필요가 없습니다.

• 스칼라 또는 배열
• 선언시 알려진
• 불변

@const is also not part of the PHPDoc standard. PHP-FIG suggests @var but this is not backed by PHPDoc and doesn't add any information you can't already deduce from the declaration itself.

Therefore, for the sake of readability I recommend just using a plain PHPDoc docblock to document your constants:

class Foo
{
    /** This is a constant */
    const BAR = 'bar';
}

It will describe the constant when you generate PHPDocs yet keeps the comments clean and readable.

참고URL : https://stackoverflow.com/questions/6706051/what-is-the-correct-way-to-write-phpdocs-for-constants