V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
coo
V2EX  ›  问与答

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

  •  
  •   coo · 2016-12-30 10:18:56 +08:00 · 1640 次点击
    这是一个创建于 2645 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

    蛮常见的一个场景,假定有如下方法(是 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');
    

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

    2 条回复    2016-12-30 10:24:28 +08:00
    jarlyyn
        1
    jarlyyn  
       2016-12-30 10:22:17 +08:00   ❤️ 1
    phpdoc.

    另外,第 2 种方法有啥意义?不如直接
    $detailID=$request->input('id');
    coo
        2
    coo  
    OP
       2016-12-30 10:24:28 +08:00
    @jarlyyn 有的时候有数个 ID 这样的参数,不能全部通过变量名称体现出来意义,需要一些解释。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   1397 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 35ms · UTC 17:33 · PVG 01:33 · LAX 10:33 · JFK 13:33
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.