苦練1天半，終於寫出了一些常用doxygen風格的vim註釋腳本

 腳本內容如下，歡迎大家補充

1. "一些常用的doxygen風格的註釋
2. "作者：peacon
3. "Email:[email protected]
4. "Copyright (c) 2008 任何人都可以自由獲取、修改、發佈該程序。
5. "參考：本腳本參考了大量的網上資料以及VIM中文手冊、doxygen user manual
6. "不足之處：函數註釋並不能提取函數的參數列表和返回值。雖然www.vim.org有大量的doxygen風格函數註釋腳本，
7. "但是經過測試我還沒有發現有完全工作正確的。提取函數參數列表的難點在於有字符串作爲默認參數以及有函數指針
8. "的參數。雖然已經想到了些方法，但是鑑於時間關係沒有去實現。如果有你實現了該功能或者有好的想法，歡迎與
9. "我進行交流。
10. 
    
12. "添加只包含一次文件的宏#ifndef ..#define #endif
13. "使用方法：在普通模式下擊鍵zho
14. function InsertPragmaOnceTag()
15.     let CurTime = strftime("%Y_%m_%d_%H_%M")    "將當前時間格式化後存入到CurTime當中去
16.     let CurFilePath = toupper(expand("%"))      "expand(/"%/")獲取當前編輯的文件路徑
17.     let LastSlash = strridx(CurFilePath, "/")   "找出路徑中最後一個/
18.     let HeadTag1 = "#ifndef "
19.     let HeadTag2 = "#define "
20.     let HeadTag3 = "#endif //"
22.     "將非數字、字母替換爲_
23.     let Suffix = substitute(strpart(CurFilePath, LastSlash + 1), "[^a-zA-Z0-9]", "_", "g")."_".CurTime  
24.     let HeadTag1 = HeadTag1.Suffix
25.     let HeadTag2 = HeadTag2.Suffix
26.     let HeadTag3 = HeadTag3.Suffix
27.     
28.     "跳轉到第一行並輸入#ifndef ..
29.     exe "normal ggO".HeadTag1                   
30.     exe "normal O".HeadTag2
31.     exe "normal Go".HeadTag3
33.     "添加一個空白行
34.     exe "normal o"
36.     "添加兩行空白行並將光標停在第四行
37.     normal 3GO
38.     normal 4GO
39. endfunction
40. 
    
42. "添加doxygen風格的文件註釋
43. "使用方法：在普通模式下擊鍵zfc
44. function InsertFileCommentTag()
45.     let l:File_Path = expand("%")
46.     let l:File_Name = strpart(l:File_Path, strridx(l:File_Path, "/") + 1)
47.     exe "normal ggO/**"
48.     exe "normal o*  @file ".l:File_Name
49.     exe "normal o*  @brief  "
50.     let l:wRow = winline()
51.     let l:wCol = wincol()
52.     exe "normal o*  @author [email protected]"
53.     exe "normal o*  @version VERSION_PLACEHOLDER"
54.     exe "normal o*  @date ".strftime("%Y/%m/%d")
55.     exe "normal o*  @note "
56.     exe "normal o*  @remarks  Copyright 1998 - 2008 Company Name Inc. All Rights Reserved."
57.     exe "normal o*/"
59.     "重新縮進文件
60.     exe "silent normal gg=G"
62.     "設置光標在@brief後面
63.     :call cursor(l:wRow, l:wCol)
64. endfunction
65. 
    
67. "添加doxygen風格的類註釋
68. "使用方法：在普通模式下，將光標停留在類名上面擊鍵zcc
69. function InsertClassCommentTag()
70.     let Class_Name = expand("<cword>")
71.     exe "normal O/**"
72.     exe "normal o*  @class ".Class_Name
73.     exe "normal o*  @brief  "
74.     let l:wRow = winline()
75.     let l:wCol = wincol()
76.     exe "normal o*  @author [email protected]"
77.     exe "normal o*  @version VERSION_PLACEHOLDER"
78.     exe "normal o*  @date ".strftime("%Y/%m/%d")
79.     exe "normal o*  @note "
80.     exe "normal o*/"
81.     exe "silent normal gg=G"
82.     :call cursor(l:wRow, l:wCol)
83. endfunction
84. 
    
86. "添加doxygen風格的函數註釋
87. "使用方法：在普通模式下面，將光標停留在函數名稱行擊鍵zmc
88. function InsertFunctionCommentTag()
89.     exe "normal O/**"
90.     exe "normal o*  @brief  "
91.     let l:wRow = winline()
92.     let l:wCol = wincol()
93.     exe "normal o*  @param "
94.     exe "normal o*  @return "
95.     exe "normal o*  @note "
96.     exe "normal o*/"
97.     exe "silent normal gg=G"
98.     :call cursor(l:wRow, l:wCol)
99. endfunction
100. 
     
102. "添加doxygen風格的結構體註釋
103. "使用方法：在普通模式下，將光標停留在結構體名稱上面擊鍵zsc
104. function InsertStructCommentTag()
105.     let l:Struct_Name = expand("<cword>")
106.     exe "normal O/**"
107.     exe "normal o*  @struct ".l:Struct_Name
108.     exe "normal o*  @brief  "
109.     let l:wRow = winline()
110.     let l:wCol = wincol()
111.     exe "normal o*  @note "
112.     exe "normal o*/"
113.     exe "silent normal gg=G"
114.     :call cursor(l:wRow, l:wCol)
115. endfunction
116. 
     
118. "添加doxygen風格的枚舉體註釋
119. "使用方法：在普通模式下，將光標停留在枚舉體名稱上面擊鍵zec
120. function InsertEnumCommentTag()
121.     let l:Enum_Name = expand("<cword>")
122.     exe "normal O/**"
123.     exe "normal o*  @enum ".l:Enum_Name
124.     exe "normal o*  @brief  "
125.     let l:wRow = winline()
126.     let l:wCol = wincol()
127.     exe "normal o*  @note "
128.     exe "normal o*/"
129.     exe "silent normal gg=G"
130.     :call cursor(l:wRow, l:wCol)
131. endfunction
132. 
     
134. "添加doxygen風格的模塊定義註釋
135. "使用方法：在visual模式下選定要加入到模塊的行，擊鍵zgc
136. function InsertGroupCommentTag()
137.     "獲取選定的行
138.     let l:wBegin = line("'<")
139.     let l:wEnd = line("'>")
140.     exe "normal ".l:wBegin."G"
141.     exe "normal O/**"
142.     exe "normal o*  @defgroup  "
143.     let l:wRow = winline()
144.     let l:wCol = wincol()
145.     exe "normal o*  @brief "
146.     exe "normal o*  @detail "
147.     exe "normal o*  @{"
148.     exe "normal o*  */"
149.     exe "normal o"
150.     let l:wEnd = l:wEnd + 7 
151.     exe "normal ".l:wEnd."G"
152.     exe "normal o/** @} */ //end define of group" 
153.     :call cursor(l:wRow, l:wCol)
154. endfunction
155. 
     
157. "在符號(宏、成員變量、全局變量)後增加doxygen風格的註釋
158. "使用方法：普通模式下，在符號定義行擊鍵zpc
159. function InsertItemPostCommentTag()
160.     exe "normal A/t"
161.     let l:wRow = winline()
162.     let l:wCol = wincol()
163.     while l:wCol < 60
164.         exe "normal A/t"
165.         let l:wCol = wincol()
166.     endwhile
167.     exe "normal A/*!<  */"
168.     exe "normal 2h"
169. endfunction
170. 
     
172. "在符號(宏、成員變量、全局變量)上方增加doxygen風格的註釋或者是函數的簡單說明
173. "使用方法：在普通模式下，在符號定義行擊鍵zuc
174. function InsertItemUpCommentTag()
175.     exe "normal O"
176.     exe "normal o///  "
177. endfunction
178. 
     
180. nmap zho <Esc>:call InsertPragmaOnceTag()<CR>i
181. nmap zfc <Esc>:call InsertFileCommentTag()<CR>i
182. nmap zcc <Esc>:call InsertClassCommentTag()<CR>i
183. nmap zmc <Esc>:call InsertFunctionCommentTag()<CR>i
184. nmap zsc <Esc>:call InsertStructCommentTag()<CR>i
185. nmap zec <Esc>:call InsertEnumCommentTag()<CR>i
186. nmap zpc <Esc>:call InsertItemPostCommentTag()<CR>i
187. nmap zuc <Esc>:call InsertItemUpCommentTag()<CR>i
188. vmap zgc <Esc>:call InsertGroupCommentTag()<CR>i