每当我输入“Printing”并在intelliJ中按CTRL Q时,我只能看到“摘要”而我看不到“Bob”。 。 。我做错了什么?
package printing;
/**
* @author Bob
* <b>Summary</b>
*/
public class Printer {
//stuff
}
***注意:我正在学习如何使用“javadoc”,所以我希望得到解释。
编辑:除非我拿出“@author”
,否则我甚至无法看到“摘要”答案 0 :(得分:2)
听起来像IntelliJ的问题/功能。 Eclipse显示整个javadoc,包括@author
。其他可能的问题是在<b>Summary</b>
之后出现@author
。
因此,请尝试删除摘要,看看会发生什么。还要尝试真正生成javadoc,例如从命令行运行javadoc
实用程序,看看会发生什么。我相信在这种情况下Bob
会出现。祝你好运。
答案 1 :(得分:2)
我可以重现此行为,并提出了跟踪此问题的问题:http://youtrack.jetbrains.com/issue/IDEA-114499
以下是我使用的代码:
package printing;
/**
* @author Simba
* @version 1
* @see java.util.Arrays
* @since 1
*/
public class Printer {
}
结果文件:
但是,如果您尝试使用以下设置通过Tools -> Generate JavaDoc
生成javadoc:
然后,生成的生成的javadoc确实显示了作者标记:
因此证明javadoc本身是声音,并且IntelliJ不显示它。
答案 2 :(得分:0)
从控制台使用javadoc
时,您可以将-author
和-version
选项添加到此类调用中( -d
设置输出目录< / em>的):
javadoc src/main/java/com/*.java -d src/docs/javadocs/ -author -version
使用这些设置显示作者和版本。
javadoc
帮助(仅输入javadoc
)显示以下内容 - 已提及AlexR - (缩写):
...
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
...
答案 3 :(得分:0)
如果您在命令行中执行此操作,则可以使用此命令:
javadoc -d javadoc -author -version YourClass.java
将.java的名称更改为您的类名称。 如果要显示作者标签,并且与版本-version
相同,则需要添加-author。请记住,-d参数用于定义文件夹并取决于您的实际路径,因此,如果您位于C:\ Users \ joselito中,则您的javadoc文件夹必须位于C:\ Users \ joselito \ javadoc >