【问题标题】:Failing to generate JavaDoc in a Maven project for the @author value with NetBeans无法在 Maven 项目中使用 NetBeans 为 @author 值生成 JavaDoc
【发布时间】:2014-05-20 23:28:42
【问题描述】:

在 NetBeans 中尝试为 Maven 项目生成 JavaDocs 时出现以下错误。

Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:javadoc 
(default-cli) on project Heur: An error has occurred in JavaDocs report generation:
Exit code: 1 - C:\Users\Admin\JavaProjects\Heur\src\main\java\com\heur\App.java:27: 
error: malformed HTML
* @author MyName <myemail @ gmail.com>

我不明白这个错误,据我所知@author 标签是正确的。为了完整起见,在此报告:

/**
 *
 * @author MyName <myemail @ gmail.com>
 * @version 1.0.0
 * @since 4-apr-2014
 */

【问题讨论】:

    标签: java maven netbeans javadoc


    【解决方案1】:

    您需要像这样转义&lt;@&gt;

    {@literal <}myemail {@literal @} gmail.com{@literal >}
    

    &lt;&gt; 替换为() 可能更清楚:

    (myemail {@literal @} gmail.com)
    

    编辑:

    或者按照您的建议,只需将批次标记为literal

    {@literal (myemail @ gmail.com)}
    

    【讨论】:

    • 此时,为什么不写{@literal &lt;myemail@gmail.com&gt;}
    • @mat_boy 是的,这样更好,我将专注于需要转义的角色,尽管我仍然会放弃 &lt;&gt;
    • 您能解释一下为什么代码的注释通常没有{@literal .... } 标记吗?
    • @mat_boy 解析 JavaDoc cmets 以生成 HTML,解析器正在寻找指示特殊值的 @ 标记,但在您的原始示例中 @ gmail.com 不是有效表达式所以必须转义
    猜你喜欢
    • 2017-06-16
    • 2011-08-25
    • 2011-03-11
    • 2015-02-14
    • 1970-01-01
    • 1970-01-01
    • 2012-04-15
    • 1970-01-01
    • 2015-03-20
    相关资源
    最近更新 更多