執行Doxygen的API

Question

我想在我的源代碼插入我的代碼庫時自動執行Doxygen。有沒有我可以在我的java代碼中使用doxygen的API /接口來開始執行？

Answer 1

Doxygen本身是通過執行一個命令行命令啓動的，所以你只需要一種執行命令的方式。您不會說SCC工具，Dev Environment或您正在使用的操作系統，所以很難給出具體的答案。

通常的做法是使用運行持續集成的構建服務器。也就是說，當你簽入代碼時，構建服務器會注意到簽入，獲取新代碼，然後執行構建（在這種情況下爲Doxygen文檔）。有many tools available將使PC自動生成構建服務器。使用哪一個將取決於您使用的操作系統和源代碼管理包等內容。 （如果你沒有/需要一個專用的構建服務器，你也可以在你自己的PC上在後臺運行這樣的工具）。

如果您只是希望在您辦理登機手續時在您自己的PC上進行構建，那麼您可以調查您的源代碼管理軟件，以查看是否可以通知您登記入住。一些SCC可能提供執行某些事件的腳本或命令的功能，因此可以讓它爲您執行命令。最後，很多人只是在他們的開發環境中設置了一個工具/宏來執行Doxygen，然後他們手動運行它。在Visual Studio中（例如），您甚至可以編寫一個宏來執行Check in和從單個按鍵中執行Doxygen。

Answer 2

如果您想要使用doxygen進行更多控制，您還必須生成xml文件並創建一個程序來分析xml輸出文件以檢查所有約束，並在違反約定時停止構建。

這種技術需要一些開發努力，但它是我知道用doxygen做你想要的東西的唯一方法。