兩個VS的文件工具

2021-09-24 15:58:29 字數 890 閱讀 5225

做個筆記:

當 xml 注釋協助將源**注釋自動轉換為 rtf 幫助文件時,仍須寫入注釋文字,這是一項令很多開發人員感到精疲力盡的工作。為什麼不使用自動化來加速這些注釋的建立呢?這正是 ghostdoc 1.9.5 試圖實現的目標。

ghostdoc 是乙個免費的 visual studio 載入項,由 roland weigelt 建立,用來協助編寫 xml 注釋。一旦安裝了 ghostdoc,只要使用它指一指、點一點,就能輕鬆地自動生成 xml 注釋。例如,若要將 xml 注釋新增到某個方法中,只需在該方法中右鍵單擊,然後從上下文選單中選擇「document this」選項。然後,ghostdoc 就會根據該方法的型別、引數、名稱和其他上下文資訊為其自動生成 xml 注釋文字。

如果您正在 .net framework 中為使用某個型別的屬性或方法生成文件,則 ghostdoc 將會使用 microsoft 已為該型別編寫的文件。如果您使用 pascal 大小寫格式或 camel 大小寫格式,ghostdoc 可將該名稱拆分成幾個單詞,並分析這些單獨的單詞,以生成文件。所有的文件邏輯都按照 ghostdoc 的生成規則來處理。既可以對這些內建規則進行自定義,也可以新增新的規則。還可以匯出這些規則,以便在其他計算機上使用。

除最簡單的成員外,您不能完全依賴 ghostdoc 為您編寫 xml 注釋。ghostdoc 自動生成的注釋只是建議,還需開發人員進行審核。無論如何,ghostdoc 是乙個值得一試的注釋編寫外掛程式,它可以節省大量時間。

**:

根據xml注釋自動生成幫助檔案的開源軟體,就不用多介紹了。

**:因為 ndoc不支援.net framework 1.0 以上的版本,所以似乎用處不大了,這裡有

支援2.0的版本,

支援vs 2005的版本:

不過都是beta版,功能不全。

兩個VS的文件工具

做個筆記 當 xml 注釋協助將源 注釋自動轉換為 rtf 幫助文件時,仍須寫入注釋文字,這是一項令很多開發人員感到精疲力盡的工作。為什麼不使用自動化來加速這些注釋的建立呢?這正是 ghostdoc 1.9.5 試圖實現的目標。ghostdoc 是乙個免費的 visual studio 載入項,由 ...

兩個vs2005的問題

問題1 準備新建乙個專案,卻發生一件奇怪的事情,系統報告 automation伺服器不能建立物件 錯誤。然後在解決方案中只見專案名,而不見專案檔案了。真是奇怪。再嘗試開啟已有專案,卻一切正常。windows應用程式,控制台,或是web應用程式,都無法建立。解決方法 只需要執行 regsvr32 sc...

介紹兩個UML工具

我這些年來用過的uml工具加起來沒有幾十個也有十幾個,覺得其中最好用的僅有兩個 其一為visual paradigam,其二為magicdraw uml。至於大名鼎鼎的rational rose 現在是ibm rational rose 乃是我見過的最大 最難用的怪獸,嘿嘿。什麼是好用?在我的經驗中...