[英]How do I stop javadoc from generating documentation for super classes?
上下文:NetBeans 8.0.2,Java 8.0.0
我編寫了幾個類來封裝對話框,以幫助我的學生編寫簡單的可視化應用程序,而無需熟悉GUI編程 - 例如Tic-Tac-Toe。 不幸的是我做了一些擴展JFrame的類,現在我的javadoc中充斥着從類層次結構繼承的長列表,使它看起來有些令人生畏。
我知道我可以將我的實現策略重新構造為“使用”JFrame而不是“成為”JFrame,但是有一些更簡單的方法來告訴javadoc只是不生成基於類層次結構的文檔嗎?
謝謝。
編輯:
我正在使用NetBeans生成器開箱即用,具有以下附加選項:
-stylesheetfile C:\Users\jack\Documents\NetBeansProjects\CartesianPlane/src/customStylesheet.css -overview "C:\Users\jack\Documents\NetBeansProjects\CartesianPlane/src/Overview.html" -subpackages edu.pcwe.uw.javaintro.cartesian_plane -exclude edu.pcwe.uw.javaintro.cartesian_plane.test
此問題已在Javadoc常見問題解答中列出
A16。 如何排除或跳過某些公共成員或類別的記錄?
[...]目前沒有Javadoc選項可以從javadoc生成的文檔中隱藏,排除或禁止公共成員。
由於它是自動生成的,並且您無法排除,因此您必須處理它。
您可能希望閱讀整個請求,因為它提供了一些排除的解決方法,但我不確定它是否適合您的情況。
編輯:
在我鏈接的請求中提到的yDoc
(現在根據您的評論重命名為yWorks
)doclet提供了使用y.exclude
進行一些排除的可能性。
請注意,您必須在超類上指定y.exclude
。 由於JFrame是標准JDK的一部分,因此您將無法指定它。 除非您想重新編譯它,否則很高興知道您有一個解決方法來為您自己的類執行此操作。
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.