编程语言
首页 > 编程语言> > php-类,函数等之前的长描述性代码块的技术名称

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

作者:互联网

我知道在PHP中(就像许多其他语言一样),人们在类,函数和文件之前的每一行之前添加带星号的描述性注释块.他们有正式名字吗?

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

解决方法:

这来自Java的上下文(称为JavaDoc),其中提供了一段详细信息,包括但不限于参数,返回值等.

如果是Java …

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

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

JavaDoc只是名称,但是它可以用于任何语言.

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

在NetBeans中,在PHP中找不到文档时:

在NetBeans中,使用PHPDocs:

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

标签:comments,standards,php
来源: https://codeday.me/bug/20191118/2028067.html