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

目录
相关文章
|
1月前
|
JavaScript IDE 程序员
你会了吗 HarmonyOS Next 项目级别的注释规范
你会了吗 HarmonyOS Next 项目级别的注释规范
50 1
你会了吗 HarmonyOS Next 项目级别的注释规范
|
3月前
|
编译器
你正在调试XXX的发布版本,如果在启用 仅我的代码 的同时,使用通过编译器优化的发布版本
你正在调试XXX的发布版本,如果在启用 仅我的代码 的同时,使用通过编译器优化的发布版本
39 0
|
6月前
|
自然语言处理 IDE 开发工具
利用codeGeex在IDE中自动写注释、自动补充简单编码。
利用codeGeex在IDE中自动写注释、自动补充简单编码。
222 2
|
编译器 Go 索引
Go 官方标准编译器中所做的优化
Go 官方标准编译器中所做的优化
69 0
|
Linux C++ 开发者
国产开源编辑器Notepad--,誓要替换掉Notepad++
国产开源编辑器Notepad--,誓要替换掉Notepad++
702 0
|
IDE 开发工具 C语言
xmake v2.1.5版本新特性介绍
2.1.5版本现已进入收尾阶段,此版本加入了一大波新特性,目前正在进行稳定性测试和修复,在这里,先来介绍下新版本中引入了哪些新特性和改进。
1125 0
|
IDE 开发工具 C#
Visual Studio 2022 Preview 2 发布:扩展跨平台功能,支持实时预览,debug 更高效
Visual Studio 2022 Preview 2 发布:扩展跨平台功能,支持实时预览,debug 更高效
1018 0
Visual Studio 2022 Preview 2 发布:扩展跨平台功能,支持实时预览,debug 更高效
|
人工智能 自然语言处理 前端开发
VS Code能自己编程了,GitHub推出“AI程序员”插件,根据注释自动补全代码
VS Code能自己编程了,GitHub推出“AI程序员”插件,根据注释自动补全代码
790 0
VS Code能自己编程了,GitHub推出“AI程序员”插件,根据注释自动补全代码
|
编解码 JavaScript Linux
Sublime Text 4 首个稳定版终于来了:支持 GPU 渲染、兼容旧版本、Python API 升级
Sublime Text 4 首个稳定版终于来了:支持 GPU 渲染、兼容旧版本、Python API 升级
Sublime Text 4 首个稳定版终于来了:支持 GPU 渲染、兼容旧版本、Python API 升级
|
iOS开发
iOS生成标准的注释工具——VVDocumenter
iOS生成标准的注释工具——VVDocumenter
268 0
iOS生成标准的注释工具——VVDocumenter