5

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
     */

我似乎无法搜索它?我可以使用什么关键字进行搜索?它进入代码还是只是评论?

4

9 回答 9

7

This is called DocBlock style commenting. In general, code should be commented prolifically. It not only helps describe the flow and intent of the code for less experienced programmers, but can prove invaluable when returning to your own code months down the line. This is not a required format for comments, but it is recommended.

DocBlock style comments preceding class and method declarations so they can be picked up by IDEs:

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

Source:Click!

In IDEs like netbeans,this commenting style is detected and the * pointers are automatically generated (like in listing pointers). All you have to do is open /** and press Enter!

于 2012-08-08T04:35:49.593 回答
4

/*开始评论。之后的任何其他内容,直到第一个*/是评论的一部分,所以第二个*没有/**什么特别的 - 只是评论的一部分。一些内联文档/代码注释系统可能会觉得它很重要,但对于 PHP 来说,它绝对没有任何意义。

于 2012-08-08T04:09:59.390 回答
3

/*开始多行注释,以*/

/**特别适用于 phpdoc 和可能的其他一些 PHP 文档生成软件。您必须使用/**该软件来获取评论并从中创建文档。 /*只有不会做。

于 2012-08-08T04:13:10.533 回答
1

它只是用来注释一段代码。这是一个例子:

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

您还可以使用 // 注释单行,如下所示:

//this is a comment
于 2012-08-08T04:11:22.887 回答
1

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

于 2012-08-08T04:12:27.677 回答
1

这是注释的开始,它将由像 Doxygen 这样的文档生成器转换为功能文档。该/*部分开始一个以 结尾的普通 PHP 注释*/,额外的星号将注释标记为元数据以供外部处理。

于 2012-08-08T04:15:22.957 回答
1

/**正如多次提到的, 是 PHP 注释块的开始。您可以在PHP 手册中阅读有关 PHP 注释的更多信息。

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

于 2012-08-08T04:17:04.530 回答
0

/*是一个多行注释标签。那是开始标签,*/也是结束标签。

于 2012-08-08T04:10:11.743 回答
0

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

您还可以使用:

//content goes here这将评论该特定行上的所有内容

于 2012-08-08T04:12:19.443 回答