php - 类、函数等之前的长描述性代码块的技术名称

Question

我知道在 PHP(与许多其他语言一样)中，人们在类、函数和文件之前的每一行之前添加带有星号的描述性注释 block 。他们有正式名称吗？

/**
* 
* Do these types of bullet-ed block comments have any official name?
* 
*/

Answer 1

这来自 Java 的上下文，称为 JavaDoc , 在这里你给出一段细节，包括但不限于参数，返回值等。

如果是 Java...

A documentation comment is framed by slash-star-star and star-slash (i.e. /** ... */). The documentation is in the HTML format.

HTML 格式随后由 Eclipse 或 Netbeans 或其他类似的 IDE 呈现，作为特定功能的提示。

JavaDoc 只是名称，但它可以用于任何语言。

在 Eclipse 中用于提示(代码辅助)的 JavaDoc 示例是:

在 NetBeans 中，当在 PHP 中找不到文档时:

在 NetBeans 中，使用 PHPDocs:

_{(来源:netbeans.org)}

它以这种方式在 NetBeans 中显示: