667
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
最後更新：2017-04-03 16:48:47