讨论一下怎么给方法写注释

2016-12-30 10:18:56 +08:00
 coo

一直有个困惑,想了好几天了。

蛮常见的一个场景,假定有如下方法(是 Laravel 的):

class MyController extends BaseController
{
    public function detail(Request $request)
    {
        $id = $request->input('id');

        return Detail::find($id);
    }
}

访问这个方法的路径是:/my/detail?id=1

ID 参数因为是 Query 参数无法通过路由指定到函数参数中,那么我应该怎么给 ID 参数写注释?

和 $request 一起写在上面的注释块中:

/**
 * 返回指定 ID 的详细信息
 * @param Request $request
 * @param Integer $id
 * @return \Illuminate\Http\JsonResponse
 **/

还是在代码中:

// Detail ID
$id = $request->input('id');

对于这样的代码注释大家是怎么写的?

1803 次点击
所在节点    问与答
2 条回复
jarlyyn
2016-12-30 10:22:17 +08:00
phpdoc.

另外,第 2 种方法有啥意义?不如直接
$detailID=$request->input('id');
coo
2016-12-30 10:24:28 +08:00
@jarlyyn 有的时候有数个 ID 这样的参数,不能全部通过变量名称体现出来意义,需要一些解释。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/331169

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX