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

Question

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

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

Answer 1

这来自Java的上下文，称为JavaDoc，您可以在其中提供一段细节，包括但不限于参数，返回值等。

如果是Java ......

  

文档注释由斜线星号和星号斜线（即/ ** ... * /）构成。文档采用HTML格式。

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

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

用于在Eclipse中进行提示的JavaDoc示例（代码辅助）是：

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

在NetBeans中，使用PHPDocs：

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

Answer 2

他们被称为DocBlocks。对于PHP，有一个公认的语法implemented by phpDocumentor

  

实际上，DocBlock实际上是一个所谓的DocComment和PHPDoc域特定语言（DSL）块的组合的名称。 DocComment是包含可根据PHPDoc标准格式化的文档的容器。

     

DocComment以正斜杠和两个星号（/**）开头，类似于您启动多行注释但带有额外星号的方式，并以星号和正斜杠结束（{{1} }）。 DocComments的大小可能是单行，但也可能跨越多行，在这种情况下，每行必须以星号开头。习惯并且建议在跨越多条线时垂直对齐星号。