在 PHP 中,"**" 是什么意思?

6
在PHP中,"/**"的意思是多行注释的开始。例如:
/**
     * Method to display a view.
     *
     * @param   boolean         If true, the view output will be cached
     * @param   array           An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
     *
     * @return  JController     This object to support chaining.
     * @since   1.5
     */

我好像无法搜索到这个内容?请问需要使用什么关键词才能搜索到呢?它是在代码中还是注释中?

9个回答

8
这被称为DocBlock风格的注释。通常情况下,代码应该大量注释。它不仅有助于为经验不足的程序员描述代码的流程和意图,而且当数月后返回自己的代码时,可以证明是非常有价值的。这不是必需的注释格式,但建议使用。
在类和方法声明之前,采用DocBlock风格注释,以便IDE能够捕获: DocBlock
    /** 
    * Super Class *
    * @package Package Name 
    * @subpackage Subpackage 
    * @category Category 
    * @author Author Name 
    * @link http://example.com 
    */
     class Super_class {

来源:点击查看!

在像netbeans这样的IDE中,会检测到这种注释风格,并自动生成星号指针(就像列表指针一样)。你所需要做的就是打开/**并按Enter键!


并没有真正解释 /** 与 PHP 认定的“注释”之间的关系。 - Lightness Races in Orbit

4

/* 开始一个注释。在第一个 */ 之前的所有内容都是注释的一部分,因此 /** 中的第二个 * 并没有什么特别之处 - 它只是注释的一部分。某些内联文档/代码注释系统可能会认为它具有重要意义,但对于 PHP 来说,它根本没有任何意义。


3

/* 开始多行注释,以 */ 结束。

/** 是特殊的 PHPDoc 注释格式,可能也适用于其他 PHP 文档生成软件。你必须使用 /** 才能让此类软件提取注释并根据它们生成文档。仅使用 /* 无法达到这一效果。


1

它仅用于注释一段代码块。以下是一个示例:

/* here is a block of code
And some more
And some more */

您也可以像这样使用 // 对单行进行注释:

//this is a comment

1

这是一个doxygen注释的开头。参见http://www.doxygen.nl/index.html。 Doxygen从特定格式的注释中创建文档。 @param和@returns是doxygen识别的标记。 Doxygen作为一种为许多语言和输出样式创建程序员文档的方法,几乎是行业标准。它扫描源文件,在注释中收集程序员留下的信息,然后创建各种格式的文档,例如HTML、Latex等。


1

这是一个注释的开头,将通过文档生成器(如Doxygen)转换为功能性文档。 /* 部分开始了一个普通的PHP注释,以 */ 结束,并且额外的星号标记该注释作为外部处理的元数据。


有趣的是 - 我敢肯定我在写这段代码时输入了星号,不知道它们去哪儿了!我会把它修复好。 - James McLeod
显然,星号必须用“\”转义,否则它们不会显示。 - James McLeod
如果您在撰写答案时阅读了格式帮助并/或观察预览窗格,那么您就会知道这一点。 - Lightness Races in Orbit
@LightnessRacesinOrbit,谢谢,我想我在过去的七年中已经弄清楚了这个问题... - James McLeod
很高兴听到这个消息!我不确定,因为您在发布此帖时已经是会员将近三年了。 - Lightness Races in Orbit

1

/**,正如多次提到的那样,是PHP注释块的开始。您可以在PHP手册中了解更多关于PHP注释的信息。

注释块中的信息用于描述其下方的方法。Joomla使用PHPDoc使用标签(例如@param@return)自动构建文档页面。您可以在this page上了解更多关于Joomla文档标准的信息。


现在原始帖子中已经删除了Joomla标签,因此Joomla的注释略微不太合理。 - John C

0

/* 是多行注释标签。这是开头标签,*/ 是结束标签。


0

/* 内容在这里 */ 用于在PHP中注释掉文本。

你也可以使用:

//内容在这里 这将注释掉该特定行上的所有内容。


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接