为什么phpDoc开放序列在`/ **'而不仅仅是`/ *`中有两颗星

Question

只有/*

，事物在视觉和机器上都很清晰

https://phpdoc.org/docs/latest/getting-started/your-first-set-of-documentation.html应该说些什么，但不是。

你的想法？

Answer 1

常规的PHP评论（/* ... */）和DocBlock（/** ... */）（或PHPDoc）之间存在差异。

PHP将两者解释为注释，但是在使用IDE时 - 他们可以解析DocBlock并为您提供更好的编程体验（带有类型提示和自动填充），如果您需要，可以使用它们导出完整的代码文档（包/类/函数/等）。

如果您以此代码为例：

<?php
 /**
  * A summary informing the user what the associated element does.
  *
  * A *description*, that can span multiple lines, to go _in-depth_ into the details of this element
  * and to provide some background information or textual references.
  *
  * @param string $myArgument With a *description* of this argument, these may also
  *    span multiple lines.
  *
  * @return void
  */
  function myFunction($myArgument)
  {
  }

您可以看到函数myFunction没有返回任何内容（@return void），它只接受一个应该是字符串的参数（$myArgument）。

要导出完整的文档，您可以使用phpDocumentor tool。