LLVM对注释的新增支持 @ WWDC 2013

简介:

很久之前我就在想:“我应该按照什么格式写注释,才能像Apple官方API那样按住Option键并点击函数名可以跳出文档说明”,如下图:


我理所当然地认为这个功能应该是根据现有注释的格式来进行排版的,于是按住Command键点进去想学习下,结果大失所望:


按照这个很基本、很普通的格式来写注释,是得不到期望的结果的。所幸在今年WWDC的Session 402中提到相关支持——What's New in the LLVM Compiler:


通过如上格式的注释,我们可以通过Option加上点击得到Quick Help:


此外,还可以在代码自动完成时看到相应注释:


方便在细节之处,有木有!?当函数名很长、只有最后一两个参数不同的时候(看不到完整函数名),再也不用瞎猜了。


这下让程序员们更有动力去编写更优美的注释了,但如果每次都手工添加上面那么多、又注重格式的注释,显然有点得不偿失。刚好Session 402的PDF文档里面(往上数第二张图)提到了Doxygen这款工具。

在网上搜索了下,参考了两篇文章(链接一链接二)。通过下载写好的Doxygen Helper,解压后双击安装到Service:


然后在键盘设置中为Xcode添加相应的快捷键:


接着打开Xcode 5,如果快捷键无效,可以再往下看:



在服务里开启相应功能,如果需要可以重启下Xcode,就可以使用快捷键来创建注释了:


显然,新的LLVM在做词法分析时还是支持了比较经典的几种注释格式的。赞一个!


到此,LLVM已经在代码的可维护性和可读性上为我们提供了更多便利。考虑到使用了Doxygen,并且有提供类似SDK基础服务的话,可以参考这篇文章,利用Doxygen将自动生成的注释文档化:



—— Jason Lee @ Hangzhou

目录
相关文章
|
监控 中间件 Java
后端技术:构建高效、稳定的服务器端应用
【10月更文挑战第5天】后端技术:构建高效、稳定的服务器端应用
385 0
|
小程序 网络安全 Windows
swoole(二)ws与wss的区别
关于ws与wss的区别这里简单的说一下我目前的见解。 如果你有更多的见解欢迎在下方留言讨论。 最简单的理解就是: 服务器上服务端用的是:websocket协议(支持客户端的ws访问) 服务器上服务端用的是:websocket协议+TLS(支持客户端的wss访问) 客户端上用的是: ws协议或者wss协议 Wss与ws其实就和http与https的关系,wss需要验证域名证书,ws不需要验证域名证书。 这个其实都不重要。我们在开发的时候关系不是很大。 下边的才是我要说的重点: Ws链接可以使用IP+端口号的形式访问。 Wss链接只能使用域名的形式访问,因为服务器端需要通过域名来找对应的ssl证书
1200 0
|
缓存 搜索推荐 数据挖掘
TPS和QPS是什么?都是什么区别?
TPS和QPS是什么?都是什么区别?
8884 4
|
10月前
|
存储 人工智能 数据库
面向金融场景的大模型 RAG 检索增强解决方案
本方案为您介绍,如何使用人工智能平台 PAI 构建面向金融场景的大模型 RAG 检索增强解决方案。
联系阿里云人工客服的四种方法(加急处理)
阿里云人工客服怎么联系?可以通过人工客服24小时电话、在线转人工或钉钉移动端、提交工单、建议与投诉四种加急处理方法,阿里云百科来详细说下联系阿里云人工客服的详细操作流程:
17219 0
联系阿里云人工客服的四种方法(加急处理)
|
小程序 前端开发 开发者
钉钉工作台的体验优化及技术思考
业务发展初期,往往是业务单引擎驱动,功能要求快速上线来追求规模化扩张,常会忽视用户体验。但数据证明,重视体验的企业发展速度远超行业平均水平。开放平台用户端产品活跃用户数超3千万,用户端的变化将直接影响千万级用户的使用体验及对钉钉的满意度。为此,我们设置了用户端体验专项。本文主要介绍本次体验优化专项的特点,产品能力体验升级背后的技术思考,以及技术视角优化的关键策略和结果。体验优化专项特点本次体验优化
1321 0
钉钉工作台的体验优化及技术思考
|
机器学习/深度学习 人工智能 自然语言处理
揭秘阿里人工智能实验室首款智能音箱——天猫精灵X1
7月5日下午,阿里人工智能实验室在北京正式发布了旗下首款智能设备——天猫精灵X1,据介绍,这款产品采用了阿里人工智能实验室自主研发的中文语义理解引擎,内置第一代中文人机交流系统AliGenie,并且依托阿里云的机器学习技术实现智能家居控制、语音购物、手机充值、音乐播放等功能。
13998 0
|
搜索推荐 BI
史上最详细!阿里云办公快速上手教程
钉钉,是一款免费沟通和协同的多端平台,上线以来,已有超过 300万企业组织正在使用,阿里云市场作为国内知名的软件服务交易平台,为解决企业通讯,销售管理以及协同办公等需求,阿里云面向中小企业推出一款企业办公套件——"阿里云办公"。
77832 0
|
人工智能 大数据 供应链
NEXT创新大会圆桌对话:重构新场景,赋能新经济
1月24日,由阿里云主办,阿里钉钉联合主办,阿里云创新中心(合肥高新)基地、迪比空间、创头条承办的“NEXT创新大会暨合肥高新区新经济发展论坛”在合肥高新区隆重举行。
|
网络协议 Ubuntu 应用服务中间件
Linux防火墙常用命令
1. 通用命令: 查看防火墙版本 iptables -version 2. RHEL6 (1) 查看防火墙状态(如果得到一系列的信息, 说明防火墙处于开启状态) /etc/init.d/iptables status (2) 开启/关闭防火墙, 重启后生效 chkconfig iptables o...