使用ghostdoc為代碼生成注釋文檔.docx
使用ghostdoc為代碼生成注釋文檔,使用ghostdoc為代碼生成注釋文檔介紹: ghostdoc是visual studio的一個(gè)免費(fèi)插件,可以幫助開發(fā)人員編寫xml格式的注釋文檔。 c#中xml格式的文檔注釋好處多多:visual studio會(huì)在很多地方顯示這些注釋內(nèi)容(例如,編輯器的工具提示或?qū)ο鬄g覽器),還有一些工具(比如ndoc或微軟的文檔工...
內(nèi)容介紹
此文檔由會(huì)員 csfujixie 發(fā)布使用GhostDoc為代碼生成注釋文檔
介紹:
GhostDoc是Visual Studio的一個(gè)免費(fèi)插件,可以幫助開發(fā)人員編寫XML格式的注釋文檔。
C#中XML格式的文檔注釋好處多多:Visual Studio會(huì)在很多地方顯示這些注釋內(nèi)容(例如,編輯器的工具提示或?qū)ο鬄g覽器),還有一些工具(比如NDoc或微軟的文檔工具Sandcastle)也可以利用這些注釋生成具有良好外觀的幫助文件。這些都讓XML格式的注釋看上去很美——但很不幸,你首先得編寫大量簡(jiǎn)單、乏味的注釋。
GhostDoc可以做什么?
GhostDoc為Visual Studio中的C#代碼編輯器安裝了一個(gè)新的命令。在編輯源文件時(shí),只需將光標(biāo)置于要添加文檔的方法或?qū)傩詢?nèi)部,然后通過熱鍵(默認(rèn)為Ctrl+Shift+D)或右鍵菜單中的Document this菜單項(xiàng)調(diào)用命令,GhostDoc就會(huì)插入一段XML格式的注釋。你也許會(huì)想到在方法或?qū)傩郧懊骀I入"http:///"時(shí)的類似效果,但是后者只能創(chuàng)建一段空的注釋構(gòu)造,而GhostDoc則能夠生成大部分實(shí)用的注釋。
如果你的類成員是用于實(shí)現(xiàn)接口或重寫基類的成員,GhostDoc會(huì)使用既存的文檔,不論這些接口或基類來自何處。這樣你就可以重用大量的微軟編寫的文檔——是否想起了在實(shí)現(xiàn)IEumerable接口時(shí),需要考慮如何為GetEnumerator()方法添加注釋。