在控制器中发现上述方法的注释是什么？

Question

这可能是个愚蠢的问题，但我对后端开发还不熟悉。

我总是在上面看到这样的评论--各种方法：

/**
 * Display a listing of the resource.
 * 
 * @return \Illuminate\Http\Response
 */
public function index()
{
    // ...
}

这些叫什么？他们有名字吗？“返回”实际上做了什么吗?还是它只是供参考呢？

我主要是问这个问题，因为作为一个初级的Laravel开发人员，我将在本周进行一次技术面试，我想确保我的所有代码都达到了他们所说的可能发生的一对编程过程的标准。

Answer 1

这些被称为"DocBlocks"，或文档块注释，等等。您可以在这里阅读更多有关它们的信息：

https://docs.phpdoc.org/guide/getting-started/what-is-a-docblock.html

https://docs.phpdoc.org/guide/guides/docblocks.html

基本上，这是一种总结方法/函数所做的、希望作为它的参数(如果有的话)以及它返回的内容的方法。IDE/代码编辑器(如VSCode、崇高文本、PHPStorm等)实际上可以阅读这些注释，并在使用它们时帮助您提供提示、自动完成等。

下面是一个基本的例子：

<?php

namespace = App\Http\Controllers;

class ExampleController extends Controller {
  /**
   * Method accepts an instance of `MyModel` and returns
   * a View responsible for displaying associated information 
   *
   * @param MyModel $myModel - An instance of `MyModel`
   *
   * @return \Illuminate\Contracts\View\View
   */
  public function myMethod(MyModel $myModel) {
    return view('index', compact('myModel');
  }
}

有了这个注释，我的VSCode实例(或者您选择的IDE )应该能够在悬停(或类似)时显示一些信息：

​

​

此外，如果我使用这个方法，我会得到一些帮助：

​

​

正如您所看到的，VSCode现在知道什么是myMethod，它期望和返回什么，以及如何使用它等等。它们不是严格要求的，因为有些IDE可以自动检测方法、参数和返回，但它们可以帮助。