php - 大家都是怎么做函数注释的
黄舟
黄舟 2017-04-11 10:24:25
[PHP讨论组]

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

黄舟
黄舟

人生最曼妙的风景,竟是内心的淡定与从容!

全部回复(6)
PHP中文网
/**
     * 获取分类商品列表
     * @param $shop_id 店铺id
     * @param $cate_id 分类id
     * @param $page    页码
     * @param $per_page 页数
     * @return mixed
     */

这是使用phpstorm自动生成的

迷茫

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

黄舟

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

ringa_lee

这样的么

/**
 *
 *
 *                                        
 *                                  .. .vr       
 *                                qBMBBBMBMY     
 *                               8BBBBBOBMBMv    
 *                             iMBMM5vOY:BMBBv        
 *             .r,             OBM;   .: rBBBBBY     
 *             vUL             7BB   .;7. LBMMBBM.   
 *            .@Wwz.           :uvir .i:.iLMOMOBM..  
 *             vv::r;             iY. ...rv,@arqiao. 
 *              Li. i:             v:.::::7vOBBMBL.. 
 *              ,i7: vSUi,         :M7.:.,:u08OP. .  
 *                .N2k5u1ju7,..     BMGiiL7   ,i,i.  
 *                 :rLjFYjvjLY7r::.  ;v  vr... rE8q;.:,, 
 *                751jSLXPFu5uU@guohezou.,1vjY2E8@Yizero.    
 *                BB:FMu rkM8Eq0PFjF15FZ0Xu15F25uuLuu25Gi.   
 *              ivSvvXL    :v58ZOGZXF2UUkFSFkU1u125uUJUUZ,   
 *            :@kevensun.      ,iY20GOXSUXkSuS2F5XXkUX5SEv.  
 *        .:i0BMBMBBOOBMUi;,        ,;8PkFP5NkPXkFqPEqqkZu.  
 *      .rqMqBBMOMMBMBBBM .           @kexianli.S11kFSU5q5   
 *    .7BBOi1L1MM8BBBOMBB..,          8kqS52XkkU1Uqkk1kUEJ   
 *    .;MBZ;iiMBMBMMOBBBu ,           1OkS1F1X5kPP112F51kU   
 *      .rPY  OMBMBBBMBB2 ,.          rME5SSSFk1XPqFNkSUPZ,.
 *             ;;JuBML::r:.:.,,        SZPX0SXSP5kXGNP15UBr.
 *                 L,    :@huhao.      :MNZqNXqSqXk2E0PSXPE .
 *             viLBX.,,v8Bj. i:r7:,     2Zkqq0XXSNN0NOXXSXOU 
 *           :r2. rMBGBMGi .7Y, 1i::i   vO0PMNNSXXEqP@Secbone.
 *           .i1r. .jkY,    vE. iY....  20Fq0q5X5F1S2F22uuv1M; 
 *
 *
 *
 * @auther Null.yang<635384073@qq.com>
 *
 * "不要误会,我不是针对你,我是说在做的各位,都是垃圾。"
 */
高洛峰

注释标准:http://flc.ren/2015/10/248.html

/**
 *
 * ━━━━━━神兽出没━━━━━━
 *    ┏┓   ┏┓
 *   ┏┛┻━━━┛┻┓
 *   ┃       ┃
 *   ┃   ━   ┃
 *   ┃ ┳┛ ┗┳ ┃
 *   ┃       ┃
 *   ┃   ┻   ┃
 *   ┃       ┃
 *   ┗━┓   ┏━┛Code is far away from bug with the animal protecting
 *     ┃   ┃    神兽保佑,代码无bug
 *     ┃   ┃
 *     ┃   ┗━━━┓
 *     ┃       ┣┓
 *     ┃       ┏┛
 *     ┗┓┓┏━┳┓┏┛
 *      ┃┫┫ ┃┫┫
 *      ┗┻┛ ┗┻┛
 *
 * ━━━━━━感觉萌萌哒━━━━━━
 */
伊谢尔伦

其实一段好的代码是不需要注释的,优雅的代码能够直接展示它的功能,只有晦涩难懂的地方才需要注释加以说明。变量名、方法名尽量一目了然,别人一看就知道这个变量是做什么的,这个方法是做什么的,这时根本是不需要对这个变量、方法增加额外的注释

热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号