欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  后端开发

大家都是怎么做函数注释的

程序员文章站 2024-01-18 15:36:28
...
一个是美观,一个是一目了然

回复内容:

一个是美观,一个是一目了然

/**
     * 获取分类商品列表
     * @param $shop_id 店铺id
     * @param $cate_id 分类id
     * @param $page    页码
     * @param $per_page 页数
     * @return mixed
     */

这是使用phpstorm自动生成的

首先注释是让人一目了然,但是跟美观没关系。。还有注释一般为两种,一种是代码行级别的,一种是方法级别的,方法级别一般要求用文档注释。

建议看下,PHP PSR代码标准编程规范
https://github.com/hfcorriez/...

相关标签: php