• 视频:世界杯路边“摄”之印象最深刻的瞬间 2019-10-08
  • 杜天皓520甜蜜来袭 粉丝舔屏福利多 2019-09-27
  • 市领导调研利用侨务资源助力经济建设情况(图) 2019-09-26
  • 这五年,砥砺奋进的河北海事局--河北频道--人民网 2019-09-25
  • 新闻有温度——西部网新闻频道(陕西新闻网) news.cnwest.com 2019-09-25
  • 连晴高温重庆动物园动物避暑尽显萌态 2019-09-01
  • 【端午话民俗】指尖上的端午节 师生一起包粽子做香包体验传统文化 2019-08-30
  • 除非必要,下定义要用是,而不是用不,懂吗?“自由发展”是什么,如果劳动还成为人们的日常负担,有自由发展吗? 2019-08-25
  • 总重430kg!日本最重组合:5名胖女孩出道了! 2019-08-22
  • 做习近平新闻思想的坚定实践者 2019-08-03
  • 广东省人大开展学习贯彻习近平总书记重要讲话精神专题集中学习研讨 2019-07-15
  • 改革开放40年来中国农村发展变化纪实——旧貌换新颜 2019-07-15
  • 学习有理丨着力改善环境 增创发展优势 2019-07-11
  • 带动乡亲干 各自有实招——三位农村社区党组织书记的故事 2019-07-07
  • 李沁出游暖萌喂鹿 笑靥如花欢快荡秋千 2019-07-04
  • 速报排球即时比分: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-10-08
  • 杜天皓520甜蜜来袭 粉丝舔屏福利多 2019-09-27
  • 市领导调研利用侨务资源助力经济建设情况(图) 2019-09-26
  • 这五年,砥砺奋进的河北海事局--河北频道--人民网 2019-09-25
  • 新闻有温度——西部网新闻频道(陕西新闻网) news.cnwest.com 2019-09-25
  • 连晴高温重庆动物园动物避暑尽显萌态 2019-09-01
  • 【端午话民俗】指尖上的端午节 师生一起包粽子做香包体验传统文化 2019-08-30
  • 除非必要,下定义要用是,而不是用不,懂吗?“自由发展”是什么,如果劳动还成为人们的日常负担,有自由发展吗? 2019-08-25
  • 总重430kg!日本最重组合:5名胖女孩出道了! 2019-08-22
  • 做习近平新闻思想的坚定实践者 2019-08-03
  • 广东省人大开展学习贯彻习近平总书记重要讲话精神专题集中学习研讨 2019-07-15
  • 改革开放40年来中国农村发展变化纪实——旧貌换新颜 2019-07-15
  • 学习有理丨着力改善环境 增创发展优势 2019-07-11
  • 带动乡亲干 各自有实招——三位农村社区党组织书记的故事 2019-07-07
  • 李沁出游暖萌喂鹿 笑靥如花欢快荡秋千 2019-07-04
  • 广西快乐十分21选5 毕博宁 体彩排列5大奖 28号湖南幸运赛车开奖结果 北京赛车pk拾平台 港彩资料6码爆庄 pk10前三技巧 稳赚 茌平特色菜 广东快乐十分走势图 大乐透专家杀号 江西多乐彩走势图开奖结果 陕快乐十分开奖结果 秒速时时彩官网平台 踩单车可以瘦腿吗 网络赚钱软件百度知道