是不是晚了点:Visual Studio可以自动生成注释啦!
蝎子
如果你正在使用Doxygen或者XML文档注释,那么Visual Studio v16.6 Preview 2了一项称之为注释自动生成(automatic comment stub generation)的新特性,这项特性将和现有的快速参考(QuickInfo), 参数帮助(Parameter Help)和成员列表提示(Member List tooltip)等特性一起为开发者提供流畅的编码体验。
让我们来自动生成注释的基本骨架
在XML文档注释中,有一些每次都必须要输入的关键字,例如summary, param等。如果每次编写注释的时候都需要手动输入这些内容,会极大的降低编码效率,同时导致非常糟糕的编码体验。Visual Studio可以通过一种十分自然的方式来自动生成注释骨架,开发者只需要在注释骨架上填写相应的内容即可。
在默认情况下,注释自动生成只会在XML文档注释上起作用。开发者在为一个函数编写注释的时候,可以通过输入三个斜杠(///)或者使用快捷键(Ctrl + /)来产生注释骨架。
有图有真相
如果我使用Doxygen呢?
如果你不使用XML注释,而是Doxygen,那么也不用太担心,Visual Studio已经为你安排的明明白白了。可以在Visual Studio的设置里自由切换你喜欢的注释系统类型,具体的设置路径:[工具/选项/文本编辑器/C/C++/编码风格/常规]。当然,你也可以直接通过快捷键(Ctrl + Q)来唤醒搜索框,并输入关键字”Doxygen”来快速定位。设置界面如下图所示:
你可以在上面的设置界面选项触发自动生成注释的代码,比如可以选择三个斜杠(///)或者/**,这完全跟随你的喜好来定。当然,快捷键(Ctrl + /)也会一直存在,如果你是一个快捷键达人,那么你应该挺喜欢这种方式。
同时,还可以通过修改[.editorconfig]配置文件来在文件夹级别或者文件级别上来指定注释系统的各项配置参数,下图是可以添加到[.editorconfig]的配置项:
为了得到一个[.editorconfig]配置文件,你可以在上面的设置界面,点击按钮[Generate .editorconfig file from settings],那么Visual Studio将会基于现有的配置来生成一个新的配置文件,然后你就可以自由的修改这个配置文件了。这种方式的好处是,你可以为不同的文件夹或者文件设置不一样的注释风格,这非常适合于不同开发团队之间的代码风格兼容。
自动生成Doxygen注释
写注释的一个好处
有些人可能会问,为什么要辛辛苦苦的写那些没用的注释呢?请先看看下图:
有感觉了吗?你编写的XML或者Doxygen注释,Visual Studio已经可以自动识别到了,并且在你调用某个函数的时自动给你信息提示。这项特性,非常适合那些写完一个函数就忘记怎么调用的人,比如我。
总结
为代码编写注释,是一个非常好的习惯,我也尽可能会在代码中写点注释,一来可以提醒我代码的基本意思,二来可以方便我的同事进行阅读。
就像上面所讲述的,如果你使用更加规范化的XML或者Doxygen风格的注释,那么生活将会开始展现它美好的一面。
特别声明:以上内容(如有图片或视频亦包括在内)为自媒体平台“网易号”用户上传并发布,本平台仅提供信息存储服务。
- 凡本网注明"来源:中国早晚报的所有作品,版权均属于中中国早晚报,转载请必须注明,http://www.zaowannews.com。违反者本网将追究相关法律责任。
- 本网转载并注明自其它来源的作品,目的在于传递更多信息,并不代表本网赞同其观点或证实其内容的真实性,不承担此类作品侵权行为的直接责任及连带责任。其他媒体、网站或个人从本网转载时,必须保留本网注明的作品来源,并自负版权等法律责任。
- 如涉及作品内容、版权等问题,请在作品发表之日起一周内与本网联系,否则视为放弃相关权利。
- 01艳压迪丽热巴,碰瓷赵丽颖,靠肖战上热搜?
艳压迪丽热巴,碰瓷赵丽颖,靠肖战上热搜?她是圈内第一绿茶?,迪丽热巴,赵丽颖,肖战,[详细]
- 02崇明岛绿地长岛重磅来袭原来这么优惠
崇明岛绿地长岛重磅来袭原来这么优惠C区核心公园。公园是C片区的核心,约60公顷亩,以[详细]
- 03娱乐圈女明星生图对比,怎么有些看着天差地别?
首先让我们来看看大幂幂同学,杨幂,1986年9月12日出生。几乎从小的时候开始就出现在[详细]
- 04DWG夺冠后Uzi复出上热搜前5!粉丝哀求乌兹出山,要让神拯救LPL
SN的失败让许多LPL观众痛苦万分,尤其是下路双人组,在面对DWG的各种进攻时显得苍白无[详细]
- 05两天6条热搜!从95花扛把子到被热搜败掉路人缘 赵露思的问题出在
原标题:两天6条热搜!从95花扛把子到被热搜败掉路人缘 赵露思的问题出在哪? 赵露思[详细]
- 06【财经分析】疫情使美国股市遭遇3月中旬以来最大单周跌幅
原标题:【财经分析】疫情使美国股市遭遇3月中旬以来最大单周跌幅 来源:新华财经 新[详细]
- 07早啊!新闻来了〔2020.10.28〕
○新疆新增确诊病例5例 喀什地区完成全员核酸检测 ○农业农村部:明年元旦春节猪肉供[详细]
- 08巴疫情指挥和行动中心要求晚10点前关闭商铺
中华人民共和国商务部网站[详细]
- 09【财经下午茶】生物质能第一股退市:欠债184亿!
欢迎光临中新经纬《财经下午茶》餐厅,这里为您提供及时、专业的财经资讯,有适合您口[详细]
- 01四川威远杜甫碑林园举办诗书画文化交流活动
十月金秋,坐落在四川省威远县新场镇中华诗圣杜甫碑林园内洋溢着浓郁传统文化气息。10[详细]
- 02苏宁金融牵手“我的南京”APP 请南京市民免费坐地铁
秋风起树叶落,在这个深秋出门的上班族,如果有人请您免费乘地铁,在寒风中是否能够感到[详细]
- 03双十一关注荣耀苏宁自营旗舰店 苏宁金融送3个月碎屏保
双十一来临,很多小伙伴都打算入手一部新手机。然而新款手机好,保护需谨慎,没有好保障,[详细]
- 04“被方便面骂了”上热搜!你要的最全方便面科普都在这里了
中国小康网讯近日,一则名为“[详细]
- 05飞融财经:长空猎金:11.3原油反弹难改弱势,37.0还是空
长空猎金:原油反弹难改弱势,37.0还是空[详细]
- 06跨界典范!亿博体育牵手波尔多足球俱乐部开创赛事娱乐新纪元
近日,一项国际体坛的跨界合作在业内引起轰动,拥有悠久历史的法国波尔多足球俱乐部官[详细]
- 07亿博体育携手波尔多足球俱乐部,开创体育娱乐新盛世
近日,亿博体育与波尔多足球俱乐部在波尔多会议中心完成战略签约仪式,自此,亿博体育[详细]
- 08这东西成饭后新宠,争议大到上了热搜~市民:在丽水,这也是儿时
深秋季节,正是吃柿子的好时候。据说,不同于感口软糯的普通柿子,脆柿是脆的,口感甜[详细]
- 09安以轩二胎产女又上热搜:她凭什么能嫁入豪门,成为人生赢家?
近日,冻龄女神安以轩二胎产女的新闻冲上了微博热搜。微博视频中她老公抱着两个宝贝一[详细]
- 01还剩9个中风险区 北京疾控中心提醒市民购买
还剩9个中风险区 北京疾控中心提醒市民购买生鲜时戴手套[详细]
- 02停车链打开汽车行业+区块链的新局面
越来越多的汽车制造商开始思考自动驾驶的发展方向。目前为止,仍然有很多尚未解决的问[详细]
- 03亚日集团OBB卫生巾、纸巾赈灾物资连夜送达临海灾区,对战“利奇
8月10日受今年9号利奇马台风登陆影响,台州临海在这场特大洪灾侵袭下,房屋、道路、农田[详细]
- 04株洲市仪器设备公司这样做网络营销推广成交量成倍增长
很多仪器设备公司认为自己的产品属于特点商品只服务与科研院校,无需做网络推广,固守[详细]
- 05苏宁金融与江苏移动开启普惠金融合作 惠及超6000万用户
在信息技术高速发展的5G时代,金融科技集团与通讯巨头的跨行业合作正在造就金融服务新[详细]
- 06官宣:领思云获得博奥奖双奖项
俗话说,是金子总会发亮的。近日,领思云企业移动学习平台以优质的综合服务和具有竞争力[详细]
- 07阳坊胜利匠心35载,只为正宗阳坊涮肉
在京城有这样一个现象,涮羊肉的餐厅有很多,但是仍然会有冲着阳坊两个字专门开车到北[详细]
- 08《金牌歌手》诺麦组合携新歌嗨翻百里杜鹃音乐节
《金牌歌手》诺麦组合携新歌嗨翻百里杜鹃音乐节 日前,万物声动百里杜鹃世界音乐节在[详细]
- 09能不能成为主角!就看绿驰汽车这款量产车型了!
据悉,在新能源产品的生产制造上面,绿驰汽车今年将上线首款量产车型,绿驰汽车本款车型[详细]