2012-01-14 75 views
0

我知道如何爲一個方法生成簡單的javadoc,但我認爲自動包含指向我方法調用的方法的鏈接會非常有用。有沒有什麼工具可以掃描方法代碼,並自動將@參考引用到javadoc中的被調用方法中?一個簡單的例子:有沒有一種工具可以生成自動生成@see對被調用方法的引用的javadoc?

如果我有一個調用B,C和D的方法A,將javadoc追加到A的javadoc中表明它調用B,C和D(以及@see指向這些方法,所以你可以閱讀他們的javadoc)。

我真正想要的是一個工具,它將生成過程流文檔,其中我所做的就是像我平常那樣記錄我的代碼,運行此工具,然後結束文檔,它會告訴我什麼是我的方法,以及它調用的所有其他方法(最好按調用方法的順序)。

當然這樣的工具存在(可能其中多個),我敢打賭,有很多意見,哪一個是最好的。

回答

0

使用「Doxygen」。

即使沒有@see標籤,也可以得到函數的關係。

記住編輯conf文件,請確保您有打開「FUNCTION_CALL」開關。(對不起,我不是交換機的名稱很確定)

0

我不認爲這樣的工具存在。我希望它不會。文檔的目的是讓事情更清楚,我認爲如果每個方法調用都添加了@see,那麼最終會得到一堆意大利麪條。 (美味,但沒有你想要排序。)你應該寧願限制@see的相關或相關的方法。

當然你也可以添加代碼插入Javadoc,並有可能一種方式來獲得源代碼的方法調用鏈接到的Javadoc。當然,您可以使用「Open Declaration(F3)」選項跳轉到Eclipse中的方法聲明。

+0

我在一個基於任務的框架中,每個任務在那裏工作班級非常小,並且只需要調用相對較少的其他任務。在這種情況下,知道哪些任務稱爲其他任務會非常有幫助。但總的來說,我同意你的看法。 – user1148956 2012-01-14 14:12:53

相關問題