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

目录
相关文章
|
8月前
|
IDE 小程序 API
【社区每周】IDE 3.8.10 Beta 版新增按需编译功能(1月第四期)
【社区每周】IDE 3.8.10 Beta 版新增按需编译功能(1月第四期)
71 6
|
14天前
|
人工智能 自然语言处理 IDE
CodeFuse IDE 0.7 版本发布,支持 Lint Error 智能改写
CodeFuse IDE 0.7 版本发布,支持 Lint Error 智能改写和 zsh 终端自然语言生成命令。它基于蚂蚁自研大模型和 OpenSumi 框架开发,提供代码编写建议、解释、单测生成等功能,提升开发效率。内置插件升级至 VS Code 1.88.1,未来将支持更多模型服务。下载地址:[GitHub](https://github.com/codefuse-ai/codefuse-ide/releases)。
31 4
|
3月前
|
JavaScript IDE 程序员
你会了吗 HarmonyOS Next 项目级别的注释规范
你会了吗 HarmonyOS Next 项目级别的注释规范
80 1
你会了吗 HarmonyOS Next 项目级别的注释规范
|
JavaScript 前端开发 Java
uniapp Android 原生插件开发(Module 扩展为例·2022)(一)
uniapp Android 原生插件开发(Module 扩展为例·2022)
1620 0
uniapp Android 原生插件开发(Module 扩展为例·2022)(一)
|
编译器 Go 索引
Go 官方标准编译器中所做的优化
Go 官方标准编译器中所做的优化
78 0
|
Java 开发工具 Android开发
uniapp Android 原生插件开发(Module 扩展为例·2022)(二)
uniapp Android 原生插件开发(Module 扩展为例·2022)
613 0
uniapp Android 原生插件开发(Module 扩展为例·2022)(二)
|
并行计算 开发工具 Windows
xmake新增对Cuda代码编译支持
最近研究了下NVIDIA Cuda Toolkit的编译环境,并且在xmake 2.1.10开发版中,新增了对cuda编译环境的支持,可以直接编译*.cu代码。
1193 0
Markdown 额外语法支持-有道云笔记
有道云笔记内置Markdown编辑器和使用指南,非技术类笔记用户,千万不要被「标记」、「语言」吓到,Markdown的语法十分简单,常用的标记符号不超过十个,用于日常写作记录绰绰有余,不到半小时就能完全掌握。
349 0
Markdown 额外语法支持-有道云笔记
|
iOS开发
iOS生成标准的注释工具——VVDocumenter
iOS生成标准的注释工具——VVDocumenter
280 0
iOS生成标准的注释工具——VVDocumenter
iOS8新特性扩展(Extension)应用之三——照片编辑插件
iOS8新特性扩展(Extension)应用之三——照片编辑插件
164 0
iOS8新特性扩展(Extension)应用之三——照片编辑插件