Javadocs - @param名称未找到

时间:2017-11-21 16:30:49

标签: java parameters constructor javadoc

我正在尝试记录我的一个课程,但我一直得到同样的错误,我不明白为什么或如何解决它。

以下是代码的相关部分:

/** Set the health. 
    @param health The health of the enemy */
    public void setHealth(float health) {
        this.health = maximum_health;
    }

    /** initialising */
    public void initialise() {
        setName("NONE");
    }

    /** Constructor for the base enemy
    @param name The name of the enemy
    @param health The health of the enemy */
    public BaseEnemy(String name) { 
        initialise();
        setName(name);
        setHealth(health);
        }

我在提交文件时得到的错误如下:

Generating code/classes/docs/baseDoc/com/ama747/enemies/BaseEnemy.html...
code/src/BaseEnemy/BaseEnemy.java:27: error: @param name not found
    @param health The health of the enemy */

我的问题如下:导致我的错误的原因是什么?如何解决?

3 个答案:

答案 0 :(得分:2)

它说问题正确。您的构造函数中没有名为“health”的参数。

答案 1 :(得分:1)

这是一个格式问题:

/**
 * 
 * @param health he health of the enemy
 */
public void setHealth(float health) {
    this.health = maximum_health;
}

答案 2 :(得分:0)

正如@мυѕτавєւмo指出的那样,这似乎是格式化问题。 Javadocs注释必须以/ **开头,并且必须以* /结尾,额外的行以*开头。根据javadoc文档,它是强制性的:

http://www.oracle.com/technetwork/articles/java/index-137868.html

  

Java源代码中由/ ** ... * / delimiters分隔的特殊注释。这些注释由Javadoc工具处理以生成API文档。

在您的初始示例中,未遵守这些规则。