• 坚持“九二共识”,路才越走越宽(观沧海) 2019-06-30
  • 十堰神定河水质净化工程6月底试运营 2019-06-27
  • 网友自嘲工资拖后腿 专家:衡量个人收入需更多数据 2019-06-23
  • 人大代表网络平台-天山网 2019-06-20
  • 即使中美贸易归零,中国也不会屈服美国的大棒政策 2019-06-20
  • 百姓故事:蒋姐姐的旗袍人生 2019-06-09
  • C919首飞机组技术支持团队:和大飞机一起舞动青春 2019-06-09
  • 广西工商局多年坚持开展升国旗奏国歌仪式 2019-06-08
  • “首届中国非处方药行业品牌宣传月”活动将在北京举办 2019-06-08
  • 社会主义社会按劳分配是建立在公有制和私有制并存基础上的,共产主义社会按需分配是建立在公有制基础上的,所有制基础不同,其分配形式也就不同。所谓“共产主义... 2019-06-07
  • 3月快递业务量料同比增长30% 2019-06-07
  • 【学习时刻】华侨大学黄日涵:“一带一路”盛会开启合作发展新篇章 2019-06-06
  • 泼皮无赖风水神,尔有脸能告诉大家这个————“腐败分子是天上掉下来的吗?”————跟帖是哪一个主帖下边的跟帖? 2019-06-05
  • 候选企业:兴业银行包头分行 2019-06-04
  • 部分MacBook Pro存在硬件问题 需同时换主板和SSD 2019-06-03
  • 体彩贵州11选5玩法:sublime注释插件与javascript注释规范

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

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

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

    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-06-30
  • 十堰神定河水质净化工程6月底试运营 2019-06-27
  • 网友自嘲工资拖后腿 专家:衡量个人收入需更多数据 2019-06-23
  • 人大代表网络平台-天山网 2019-06-20
  • 即使中美贸易归零,中国也不会屈服美国的大棒政策 2019-06-20
  • 百姓故事:蒋姐姐的旗袍人生 2019-06-09
  • C919首飞机组技术支持团队:和大飞机一起舞动青春 2019-06-09
  • 广西工商局多年坚持开展升国旗奏国歌仪式 2019-06-08
  • “首届中国非处方药行业品牌宣传月”活动将在北京举办 2019-06-08
  • 社会主义社会按劳分配是建立在公有制和私有制并存基础上的,共产主义社会按需分配是建立在公有制基础上的,所有制基础不同,其分配形式也就不同。所谓“共产主义... 2019-06-07
  • 3月快递业务量料同比增长30% 2019-06-07
  • 【学习时刻】华侨大学黄日涵:“一带一路”盛会开启合作发展新篇章 2019-06-06
  • 泼皮无赖风水神,尔有脸能告诉大家这个————“腐败分子是天上掉下来的吗?”————跟帖是哪一个主帖下边的跟帖? 2019-06-05
  • 候选企业:兴业银行包头分行 2019-06-04
  • 部分MacBook Pro存在硬件问题 需同时换主板和SSD 2019-06-03
  • 超级高速公路之王官网 巴塞罗那大学 云南时时彩开奖直播 蝙蝠侠崛起APP 新快3彩票是不是真的 秒速赛车计划软件万能码 26选5基本走势图 广东快乐十分走势图表分析 篮球巨星豪华版电子游戏 北京十一选五开奖号码