phpDoc class constants documentation

前端 未结 2 1662
臣服心动
臣服心动 2020-12-10 01:00

How do I document class constants for phpDoc? I\'ve read the manual but I can\'t find anything about them.

相关标签:
2条回答
  • 2020-12-10 01:27

    Constants only need a docblock that contains the description. No specific tag is necessary. The code parser itself identifies constants and displays them as such in the generated documentation (here's an example).

    0 讨论(0)
  • 2020-12-10 01:46

    I'm fairly sure that you can use @const, though I can't find any English documentation. There's a German example here. It shows define statements rather than class constants, but IIRC the syntax is the same.


    Nine years later, an edit...

    It is clear now that the above is bad advice as @const has not appeared in the docs and it seems it will not.

    Using @var seems to work, though I cannot see it explicitly specified anywhere.

    0 讨论(0)
提交回复
热议问题