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