Doxygen中的所見即所得

Question

我正在開發一個用C語言編寫的相當大的項目。這個想法是構建一個模塊化塊庫，可以在多個平臺上重複使用。每個模塊都與.docx格式的文檔文檔相關聯（巨大的差異合併）。在這些文檔中，指定了一個接口部分，列出了數據類型和可公開訪問的函數。這些經常與代碼中的實際實現不一致，涉及所有這些文檔是一件痛苦的事情。

我一直在努力改用doxygen來簡化文檔管理。我還沒有找到將以前編寫的文檔嵌入到doxygen輸出中的好方法。我將它們複製粘貼到各個部分中，並使用模塊將源代碼組合在一起，但文檔部分在註釋中看起來很難看（輸出很漂亮），並且由於doxygen需要一段時間來解析代碼（大約30分鐘），驗證格式化是一種痛苦。

有沒有辦法將WYSIWYG的大塊文件轉換成doxygen？我覺得這會提高記錄代碼的人數以及文檔的質量。我考慮鏈接到HTML，但是這分開了文檔。我也考慮過把它們內聯在html中，但這看起來也很痛苦，意味着每個人都需要一個所見即所得的HTML編輯器（或者一些html技巧）。

有關如何使事情變得更簡單和更漂亮的任何想法？

謝謝加載。

Answer 1

我建議在HTML中打印Word文檔。 Doxygen可以包含HTML文檔或至少可以接受評論和描述中的HTML語法。

Answer 2

您可以在您的評論中放入<pre> ... </pre>部分，並操縱一點點.css，您可以根據自己的喜好對其進行格式化。

Answer 3

我的加載項，Atomineer Pro Documentation可能會有所幫助。

它還沒有提供wysiwyg，但它確實有助於Doxygen或DocXML文檔註釋的日常管理和更新，這有助於使它們與代碼保持同步並以最小的努力進行整理/讀取 - 這通常會導致程序員實際記錄東西，因爲麻煩因素被最小化。

所以，很抱歉，這不是對您的問題的直接解決方案 - 但它可以幫助您通過嵌入式doxygen註釋幫助您的團隊更好，更高效地工作。