代码之家  ›  专栏  ›  技术社区  ›  Adrien Aacha

Javadocs-@param name未找到

  •  2
  • Adrien Aacha  · 技术社区  · 7 年前

    我试图记录我的一个类,但我不断得到相同的错误,我不明白为什么或如何解决它。

    以下是代码的相关部分:

    /** 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 回复  |  直到 7 年前
        1
  •  6
  •   Malaka    7 年前

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

        2
  •  3
  •   мυѕτавєւмo    7 年前

    这是一个格式问题:

    /**
     * 
     * @param health he health of the enemy
     */
    public void setHealth(float health) {
        this.health = maximum_health;
    }
    
        3
  •  0
  •   evinhas    7 年前

    正如@м…ñö„Ðl l l k l l l¼o指出的那样,这似乎是一个格式问题。 Javadocs注释必须以/**开头,并且必须以*/结尾,额外的行必须以*开头。根据javadoc文档,它是强制性的:

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

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

    在您最初的示例中,这些规则没有得到遵守。