掃描代碼評論並轉換爲標準格式的工具

Question

我正在研究一個看到許多不同作者和許多不同文檔樣式的C項目。

我的doxygen和其他文件幾代工具的忠實粉絲，我想遷移該項目使用這些系統之一。

是任何人都知道一個工具，可以掃描源代碼註釋對於喜歡「說明」，「作者」，「文件名」和其他類型的上下文智能註釋轉換爲標準格式的關鍵字？如果不是，我想我可以寫一個瘋狂的腳本，或手動轉換。

感謝

Answer 1

唯一一個我能想到當我Lex + Yacc閱讀O'Reilly的書，是，有代碼的輸出在命令行上的評論，有在第2章，顯示了部分如何解析徵求意見，包括//和/*..*/代碼...有相關示例，頁面上的鏈接，下載文件progs.zip，你要找的是ch2-09.l需要被建立的文件，它可以很容易地修改輸出評論。然後，可以在腳本中篩選出「姓名」，「說明」中使用等等

我可以在這裏發佈關於如何做到這一點，如果你有興趣的指示？

編輯：我想我已經找到你正在尋找的，預建的評論文檔提取器here。

希望這會有所幫助， 最好的問候， 湯姆。

Answer 2

我覺得作爲tommieb75表明，適當的解析器來處理這個問題的方法。

我建議在看ANTLR，因爲它支持重寫就地令牌緩衝，我認爲會減少你所要做的保留空白等什麼 - 參見本章The Definitive ANTLR reference 9.7。

Answer 3

如果您的解析風格比較有限，那麼編寫Visual Studio宏（用於IDE）或獨立應用程序（僅用於處理源代碼「脫機」）將會非常簡單，它將會搜索文件進行評論，然後使用某些標題或標籤將它們重新格式化爲新的樣式，以將它們分開。

的快捷方式，可以幫助你是用我的AtomineerUtils Pro Documentation加載項。它可以一次查找並轉換源文件中的所有註釋。開箱即可解析XML文檔，Doxygen，JavaDoc和Qt格式（或任何足夠接近它們的格式），然後可以以任何這些格式輸出評論。它也可以配置爲轉換不兼容的舊註釋。有幾個選項可以幫助轉換，但是最強大的calls a Visual Studio Macro在分析它之前帶有評論文本，允許您應用一些字符串處理將遺留註釋轉換爲AtomineerUtils隨後可以讀取的格式（一個示例宏，用於其中一個在網站上提供了最常用的遺留樣式，所以通常很簡單，只要它適合於計算機解析，就可以修改它以適應您的遺留格式）。

轉換後的文本不需要特別整齊 - 一旦AtomineerUtils可以提取文檔記錄條目，它將爲您清理註釋 - 它可以自動應用文字換行，一致元素排序和間距等，並確保註釋準確無誤描述它所記錄的代碼元素（它的條目與params，typeparams，拋出的異常等相匹配），然後以其配置的格式輸出替換註釋。這樣可以節省您在轉換宏中的大量工作，讓事情變得整潔 - 一旦完成轉換，您可以繼續使用插件來節省記錄代碼的時間，並確保所有新評論都以相同樣式繼續。