什么是PHP中的/ **?

时间:2012-08-08 04:06:46

标签: php

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 个答案:

答案 0 :(得分:6)

这称为 DocBlock 样式评论。通常,代码应该大量注释。它不仅有助于为经验不足的程序员描述代码的流程和意图,而且在几个月后返回到您自己的代码时可以证明是非常宝贵的。这不是评论所需的格式,但建议使用。

类和方法声明之前的

DocBlock样式注释,以便IDE可以选择它们:

    /** 
    * Super Class *
    * @package Package Name 
    * @subpackage Subpackage 
    * @category Category 
    * @author Author Name 
    * @link http://example.com 
    */
     class Super_class {

来源:Click!

在像netbeans这样的IDE中,会​​检测到这种注释样式,并自动生成*指针(如列表指针)。您所要做的就是打开/**并按Enter键。

答案 1 :(得分:4)

/*发表评论。之后的任何其他内容,直到第一个*/成为评论的一部分,因此*中的第二个/**并不特别 - 只是评论的一部分。一些内联文档/代码注释系统可能会发现它很重要,但对于PHP来说它绝对没有任何意义。

答案 2 :(得分:2)

/*开始以*/

结束的多行评论

/**特别适用于phpdoc以及其他一些PHP文档生成软件。您必须使用/**来获取此软件以获取注释并从中创建文档。 /*只会不会这样做。

答案 3 :(得分:1)

它只是用来评论一段代码。这是一个例子:

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

您还可以使用//注释单行:

//this is a comment

答案 4 :(得分:1)

这是doxygen评论的开始。见http://www.doxygen.nl/index.html。 Doxygen根据特殊格式的注释创建文档。 @param和@returns是doxygen认可的令牌。 Doxygen几乎是一种行业标准,作为为许多语言和输出样式创建程序员文档的一种方式。它扫描源文件,收集编码器留在评论中的信息,然后创建各种格式的文档,如HTML,Latex等。

答案 5 :(得分:1)

这是评论的开始,它将由Doxygen等文档生成器转换为功能文档。 /*部分以*/开始正常的PHP注释,额外的星号将注释标记为外部处理的元数据。

答案 6 :(得分:1)

多次注意/**是PHP注释块的开头。您可以在PHP manual

中阅读有关PHP评论的更多信息

注释块中的信息用于描述其下方的方法。 Joomla使用PHPDoc使用@param@return等标记自动构建文档页面。您可以在this page上阅读有关Joomla文档标准的更多信息。

答案 7 :(得分:0)

/*是一个多行注释标记。这是开头标记,*/是结束标记。

答案 8 :(得分:0)

/* content goes here */用于在PHP中注释文本。

您也可以使用:

//content goes here将来到该特定行的所有内容