• 广东省人大开展学习贯彻习近平总书记重要讲话精神专题集中学习研讨 2019-07-15
  • 改革开放40年来中国农村发展变化纪实——旧貌换新颜 2019-07-15
  • 学习有理丨着力改善环境 增创发展优势 2019-07-11
  • 带动乡亲干 各自有实招——三位农村社区党组织书记的故事 2019-07-07
  • 李沁出游暖萌喂鹿 笑靥如花欢快荡秋千 2019-07-04
  • 李丽珠:沉到基层 脚踏实地干工作 2019-07-04
  • 文房清供:皇帝笔架上的那些奇珍异巧 2019-06-30
  • 世界杯揭幕战:俄罗斯队胜沙特阿拉伯队 2019-06-30
  • 【新时代 新作为 新篇章】牢记嘱托 打赢脱贫攻坚战 2019-06-18
  • 中国的城市化人口已超过欧美,如果生产总值干不过,则城市化质量是有问题的。 2019-06-18
  • 2013第八届中国常州先进制造技术成果展示洽谈会——中国常州网专题 2019-06-15
  • 发展中国家的市场经济,一般会落入:资本市场、来料加工、吃喝玩乐消费、房地产疯涨,等经济基础不牢的“中等收入陷阱”。 2019-06-15
  • 《侏罗纪世界2》《泄密者》今日上映 2019-05-30
  • 河北遵化清东陵打响景区环境提升攻坚战 2019-05-30
  • 部分金交所变相突破合格投资人数量限制 2019-05-23
  • 排球比分网中国:sublime注释插件与javascript注释规范

    2015-12-30 15:32:48来源:轩枫阁 作者:

    排球比分直播捷报网 www.pwgq.net 代码中注释是不可少的,即使是自己写的代码,过了一段时间之后再重看,如果没有注释记录的话,可能会想不到当初是这样实现的,尤其是在业务逻辑比较复杂的项目,注释变得尤为重要。怎么优雅的写有用的注释呢?

    代码中注释是不可少的,即使是自己写的代码,过了一段时间之后再重看,如果没有注释记录的话,可能会想不到当初是这样实现的,尤其是在业务逻辑比较复杂的项目,注释变得尤为重要。怎么优雅的写有用的注释呢?

    Sublime注释插件-Doc​Blockr

    功能

    生成优美注释

    简介

    标准的注释,包括函数名、参数、返回值等,并以多行显示,省去手动编写

    wiki

    • https://github.com/spadgos/sublime-jsdocs
    • https://sublime.wbond.net/packages/DocBlockr

    使用方法

    1.快速注释: 输入/*、/**(在Coffee-Script中是###*),Enter

    basic

    687474703a2f2f73706164676f732e6769746875622e696f2f7375626c696d652d6a73646f63732f696d616765732f62617369632d626c6f636b2e676966

     

    2. 函数注释:使用Tab在不同的字段切换

    function-template

    687474703a2f2f73706164676f732e6769746875622e696f2f7375626c696d652d6a73646f63732f696d616765732f6c6f6e672d617267732e676966

    687474703a2f2f73706164676f732e6769746875622e696f2f7375626c696d652d6a73646f63732f696d616765732f747970652d68696e74696e672e676966

     

    3. 变量注释

    687474703a2f2f73706164676f732e6769746875622e696f2f7375626c696d652d6a73646f63732f696d616765732f766172732e676966

     

    4. 注释+评论

    safd

    sdgfvsd

    fdgfd

    sdfgds

    注释规范

    目前脚本、样式的注释格式都有一个已经成文的约定规范,最初是YUI Compressor制定。

     
    1
    2
    3
    4
    5
    6
    7
    8
    /**
    * 这里的注释内容【会】被压缩工具压缩
    */
     
    /*!
    * 这里的注释内容【不会】被压缩工具压缩
    * 与上面一个注释块不同的是,第2个*换成了!
    */

    其中说到这里说到的压缩工具有YUI Compressor 、Google Closure Compiler、gulp-uglify、grunt-contrib-uglify等,这些压缩工具都支持以上的压缩约定。常常把文件的关键信息放在第2种注释内容里,如文件名称、版本号、作者等。

    关于这些关键信息,都由一些关键词和一定的格式来书写。关键词书写格式为:

     
    1
    2
    3
    4
    /**
    * @author ydr.me
    * @version 1.0
    */

    使用@key desc格式来书写,常用的关键词有:

    关键词 描述
    @auhor 作者
    @param 参数
    @example 示例
    @link 链接
    @namespace 命名空间
    @requires 依赖???/td>
    @return 返回值
    @version 版本号

    其中,param关键词的格式为:

    1
    2
    3
    /**
    * @param {String} 参数描述
    */
  • 广东省人大开展学习贯彻习近平总书记重要讲话精神专题集中学习研讨 2019-07-15
  • 改革开放40年来中国农村发展变化纪实——旧貌换新颜 2019-07-15
  • 学习有理丨着力改善环境 增创发展优势 2019-07-11
  • 带动乡亲干 各自有实招——三位农村社区党组织书记的故事 2019-07-07
  • 李沁出游暖萌喂鹿 笑靥如花欢快荡秋千 2019-07-04
  • 李丽珠:沉到基层 脚踏实地干工作 2019-07-04
  • 文房清供:皇帝笔架上的那些奇珍异巧 2019-06-30
  • 世界杯揭幕战:俄罗斯队胜沙特阿拉伯队 2019-06-30
  • 【新时代 新作为 新篇章】牢记嘱托 打赢脱贫攻坚战 2019-06-18
  • 中国的城市化人口已超过欧美,如果生产总值干不过,则城市化质量是有问题的。 2019-06-18
  • 2013第八届中国常州先进制造技术成果展示洽谈会——中国常州网专题 2019-06-15
  • 发展中国家的市场经济,一般会落入:资本市场、来料加工、吃喝玩乐消费、房地产疯涨,等经济基础不牢的“中等收入陷阱”。 2019-06-15
  • 《侏罗纪世界2》《泄密者》今日上映 2019-05-30
  • 河北遵化清东陵打响景区环境提升攻坚战 2019-05-30
  • 部分金交所变相突破合格投资人数量限制 2019-05-23
  • 重庆幸运农场早上几点开始 山东群英会开奖 秒速飞艇开奖 曾一个码 一福建22选5开奖结果查询结果 飞五通比牛牛规则 湖南快乐十分怎么玩 香港曾道人六肖中特 顶呱刮红樱桃中的三万 老快3历史开奖结果查询 篮球经理破解版 新浪爱彩竞彩足球比分即时比分 山东11选5遗漏走势图手机版下载 c031a另波叔一波中特 彩票30选5开奖公告