究竟什么是“PHPDoc 风格的评论”？

Question

今天一个邪恶的、讨厌的虫子咬了我。长期以来，我从 PHP 脚本中计算了 PHP 源代码的“纯”行数。为此，我遍历了所有标记并删除了 T_COMMENT 的所有实例。

在手册中，https://www.php.net/manual/en/tokens.php 上写着：

T_COMMENT   // or #, and /* */  comments

事实证明，这并没有删除某种花哨的替代样式注释，显然称为“PHPDoc 样式 cmets”。在同一页上，再往下（我从未寻找过，因为我不知道它们存在），它说：

T_DOC_COMMENT   /** */  PHPDoc style comments

现在，我的代码可以工作了，因为我同时考虑了这两种情况。

但是，我仍然想知道“PHPDoc 样式注释”应该是什么，以及为什么它们不被视为 T_COMMENT 的一部分。

令人沮丧的是，该手册页上的“PHPDoc 样式 cmets”超链接只是链接到一个通用的“cmets”页面，它在任何地方都没有提到“PHPDoc”！

那么，它是什么？为什么它被认为是一种特殊的评论？为什么没有记录在案？为什么今生的一切都是该死的谜？！

Answer 1

这些类型的 cmets 用于文档工具读取，这些工具会分析您的源代码并生成有关您的函数和类的文档。例如phpDocumentor 就是这样一个生成文档的工具，类似于javadoc。