输出顶部的JavaDoc概述说明

输出顶部的JavaDoc概述说明,java,javadoc,Java,Javadoc,在JavaDoc中,我可以添加一个概览页面,作为外部创建的HTML(-overview选项)提供。 但是JavaDoc的行为是,只在页面顶部显示第一句话,然后是包含包的表,最后是概述的全部内容 有没有办法将概览的全部内容显示在生成的输出之上?可能,但不应该。Javadoc的格式在所有API中都是统一的。不要试图变得特别。第一句话应该在一句话中解释包/方法是什么。一般来说,你是对的。尽管如此,我还是想向读者指出一些重要的信息,当这些信息隐藏在页面下方时,很容易被遗漏。只有这样,它才有机会使用第一句

在JavaDoc中,我可以添加一个概览页面,作为外部创建的HTML(-overview选项)提供。
但是JavaDoc的行为是,只在页面顶部显示第一句话,然后是包含包的表,最后是概述的全部内容


有没有办法将概览的全部内容显示在生成的输出之上?

可能,但不应该。Javadoc的格式在所有API中都是统一的。不要试图变得特别。第一句话应该在一句话中解释包/方法是什么。一般来说,你是对的。尽管如此,我还是想向读者指出一些重要的信息,当这些信息隐藏在页面下方时,很容易被遗漏。只有这样,它才有机会使用第一句话,并使之成为重要信息。如果是重要信息,请告诉用户完整描述中有重要信息。不要在一行中透露太多细节。也许吧,但你不应该。Javadoc的格式在所有API中都是统一的。不要试图变得特别。第一句话应该在一句话中解释包/方法是什么。一般来说,你是对的。尽管如此,我还是想向读者指出一些重要的信息,当这些信息隐藏在页面下方时,很容易被遗漏。只有这样,它才有机会使用第一句话,并使之成为重要信息。如果是重要信息,请告诉用户完整描述中有重要信息。不要在一行中给出太多细节。