iOS生成標準的註釋工具——VVDocumenter

iOS生成標準的註釋工具——VVDocumenter

        在程序開發中,咱們免不了要寫許多註釋,方便幫別人也方便咱們本身之後檢查咱們的代碼。然而,寫註釋是一件十分浪費咱們時間與精力的事,要寫符合文檔格式的註釋,更是會消耗咱們不少的功夫,幸運的是,VVDocumenter能夠幫咱們很大的忙。git

        gitHub地址:https://github.com/onevcat/VVDocumenter-Xcodegithub

安裝與使用方法:下載github源碼,使用xcode打開工程,運行一下,若是成功,插件就安裝好了,這時,咱們必須將xcode從新啓動一下,才能夠使用。xcode

重啓xcode,在任意一個地方輸入///,即會自動出現以下的註釋模板,參數部分已經由佔位符寫好工具

/**
 *  <#Description#>
 *
 *  @param data <#data description#>
 */
- (void)updateWithData:(id)data;

是否是寫註釋變成了一件很是有趣的事,你還能夠對其進行一些設置,在xcode->window菜單欄中,有VVDocumenter這個標籤,裏面能夠對生成註釋的模板進行一些設置,好比生成註釋的快捷鍵,註釋的對齊模式,註釋顯示建立者和時間等。例如以下設置就會生成這樣的註釋:spa

/**
 *  @author Elephant, 15-09-16 13:09:28
 *
 *  @brief  <#Description#>
 *
 *  @param data <#data description#>
 */
 - (void)updateWithData:(id)data;

最後,推薦這款小插件給你,祝你寫代碼愉快O(∩_∩)O。插件

專一技術,熱愛生活,交流技術,也作朋友。code

——琿少 QQ羣:203317592ip

相關文章
相關標籤/搜索