xcode 自動新增注釋，生成文件

一、自動生成注釋**

新增乙個快捷鍵，生成 注釋**

1、開啟thisservice，進行以下配置

name:右鍵選單中的名字

script:將doxygen.rb拖拽到這裡

2、開啟系統偏好設定，找到鍵盤，進行以下配置

這裡我將快速文件注釋的快捷鍵設定成了command + option + /

3、使用

選中需要注釋的函式名，包括所有的引數，右鍵點選快速文件注釋，或者直接按快捷鍵即可。

二、生成文件

生成文件有三種方式：

docxygen 感覺是這3個工具中支援語言最多的，可以配置的地方也比較多。我大概看了一下文件，覺得還是比較複雜，而且預設生成的風格與蘋果的風格不一致。就去看後面 2個工具的介紹了。另外，它雖然是開源軟體，但是沒有將原始碼放到github上讓我感覺這個工具的開發活躍度是不是不夠。

headerdoc 是xcode 自帶的文件生成工具。在安裝完xcode後，就可以用命令列：headdoc2html + 源檔名 來生成對應的文件。我個人試用了一下，還是比較方便的，不過headerdoc的注釋生成規則比較特別，只生成以 /*! */ 的格式的注釋。還有乙個缺點是每個類檔案對應乙個注釋檔案，沒有彙總的檔案，這點感覺有點不爽。

它預設生成的文件風格和蘋果的官方文件是一致的，而doxygen需要另外配置。

可以生成docset，並且整合到xcode中。這一點是很贊的，相當於在原始碼中按住option再單擊就可以調出相應方法的幫助。

相對於headerdoc，它沒有特殊的注釋要求，可以用/** */ 的格式，也可以相容/*! */的格式的注釋，並且生成的注釋有彙總頁面。

1

23

1

beego api自動生成文件

必須設定在 routers router.go 中，檔案的注釋，最頂部 apiversion 1.0.0 title mobile api description mobile has every tool to get any job done,so codename for the new mo...

Django 自動生成文件

老是忘 記錄下 coreapi pip install coreapi rest framework from rest framework.documentation import include docs urls urlpatterns url api include docs urls ti...

VS2015自動新增注釋

記錄下建立乙個mvc5下的models資料夾下的 新增自動注釋修改檔案路徑位置 讓vs自動生成類的頭部注釋，只需修改兩個文集即可，一下兩個路徑下個有乙個 class.cs檔案 c program files x86 microsoft visual studio 14.0 common7 ide i...