PMD Class 方法内部定义

Question

我在一个方法中使用本地 class，PMD 触发 2 个警告 headerCommentRequirement 用于 class 和 publicMethodCommentRequirement 用于 class 中的一个方法，我将两者的评论写为如果它是一个正常的 class 但它不起作用。对此有什么想法吗？谢谢你的帮助。代码如下所示：

/**
* 
* @author me
*
*/
class myClass{
    void thisMethod(){
        if(condition){

            /**
            * 
            * @author me
            * This is the local class
            */
            class localClass implements otherClass{

                /**
                * Method comment
                */              
                public boolean boolMethod(){
                    //Do Something
                }
            }
        }
    }
}

Answer 1

正确的 javadoc 应该有第二行和后续行缩进额外的 space，描述应该在任何标签之前：

/**
 * Description.
 * @author me
 */

Answer 2

我在本地 class 行上使用 //NOPMD（忽略 PMD 警告）解决了这个问题，因为它不是我的 class 并且 PMD 无法识别评论。这是我得到的唯一解决方案。

class LocalClass implements OtherClass{ //NOPMD

}

PMD Class 方法内部定义

PMD Class definition inside method

warnings

pmd