为什么评论中的'@'？

Question

有时我会在某些行前面看到带有'@'的php评论。像@Author一样。这有什么特别的原因吗？我似乎无法找到任何关于此的内容。我假设有一个高度使用的解析器，它寻找'@'。

Answer 1

这很可能是phpDocumentor符号，这是一个解析源代码（和那些@注释）以自动生成文档的程序。许多IDE还基于这些注释提供智能查找和自动完成功能。

示例：

/**
 * Echoes "example".
 * @author Pekka
 * @version 1.5
 * @return void
 */
 function example()
  {
   echo "example";
  }

Answer 2

自动文档生成器使用它来从注释中创建文档。有一些工具和格式：

• 的phpDocumentor
• Doxygen的
• HeaderDoc

列举一些。

Answer 3

有很多软件包可以解析注释的源代码并创建各种格式的复杂帮助文件（如HTML，Windows .chm文件等）。显然，Java有javadoc，但还有Doxygen和Doc-O-Matic，仅举几例。