javadoc"@作者;不显示?
每当我在intelliJ中键入“Printing”并按CTRL键Q时,我只能看到“Summary”,而看不到“Bob”。我做错了什么javadoc"@作者;不显示?,java,intellij-idea,javadoc,author,Java,Intellij Idea,Javadoc,Author,每当我在intelliJ中键入“Printing”并按CTRL键Q时,我只能看到“Summary”,而看不到“Bob”。我做错了什么 package printing; /** * @author Bob * <b>Summary</b> */ public class Printer { //stuff } 包装印刷; /** *@作者鲍勃 *总结 */ 公共类打印机{ //东西 } ***注意:我正在学习如何使用“javadoc”,所以我希望您能给我一个解
package printing;
/**
* @author Bob
* <b>Summary</b>
*/
public class Printer {
//stuff
}
包装印刷;
/**
*@作者鲍勃
*总结
*/
公共类打印机{
//东西
}
***注意:我正在学习如何使用“javadoc”,所以我希望您能给我一个解释
编辑:我甚至看不到“摘要”,除非我去掉“@author”听起来像是IntelliJ的问题/功能。Eclipse显示整个javadoc,包括
@author
。另一个可能的问题是在@author
之后出现摘要
所以,试着删除摘要,看看会发生什么。还要尝试真正生成javadoc,例如从命令行运行
javadoc
实用程序,看看会发生什么。我确信在这种情况下会出现Bob
。祝你好运。我可以重现这种行为,并提出了一个问题来跟踪:
以下是我使用的代码:
package printing;
/**
* @author Simba
* @version 1
* @see java.util.Arrays
* @since 1
*/
public class Printer {
}
以及由此产生的文件:
但是,如果您尝试使用以下设置通过
Tools->generate javadoc
生成javadoc:
然后,生成的javadoc会显示author标记:
因此,要证明javadoc本身是可靠的,并且它是IntelliJ而不是显示它。当从控制台使用
javadoc
时,您可以向调用添加-author
和-version
选项,如下所示(-d
设置输出目录):
使用这些设置显示作者和版本
javadoc
帮助(只需键入javadoc
)显示以下内容-如前所述-(缩短):
。。。
由标准doclet提供:
-d输出文件的目标目录
-使用“创建类和包使用情况”页面
-版本包括@version段落
-作者包括@author段落
...
如果在命令行中执行此操作,则可以使用:
javadoc -d javadoc -author -version YourClass.java
将.java的名称更改为您的类名。
如果要显示author标记以及version-version标记,则必须添加-author
请记住,-d参数用于定义文件夹并取决于实际路径,因此如果您在C:\Users\joselito中,您的javadoc文件夹必须在C:\Users\joselito\javadoc中我认为只有在导出/生成javadoc时才会真正解析这些标记。在Eclipse中,有一种方法可以右键单击您的项目,然后导出javadoc(它自动生成html和其他内容)。我相信IntelliJ也有类似的东西。如果创建类的新实例并将鼠标悬停在其上(通常是弹出工具提示),则IDE中应该显示正常的摘要。
...
Provided by Standard doclet:
-d <directory> Destination directory for output files
-use Create class and package usage pages
-version Include @version paragraphs
-author Include @author paragraphs
...
javadoc -d javadoc -author -version YourClass.java