VSCode自动填充获取和设置信息

2019年9月20日 12点热度 0条评论

使用vscode时,它可以帮助我编写get和set方法并以以下格式自动填充它:

     /**
     * @param strength the strength to set
     */
     public void setStrength(int strength) {
        this.strength = strength;
    }

但是,如果我正在写这篇文章,我会这样做:

    /**
     * sets the strength variable
     */
    public void setStrength(int newStrength) {
        newStrength = strength;
    }

哪个更正确?另外,第一个评论中的含义是什么?

解决方案如下:

我不相信getter和setter中的参数名称有约定。因此从技术上讲,它们都是正确的。虽然,即使我不自动生成方法,我也一直使用第一个示例,但是您会发现大多数开源Java代码都将使用第一个示例。

您的评论是javadoc。 Maven和Gradle之类的构建工具提供了ability of compiling API documentation。 IDE(如VSCode)还将解析javadoc并将其动态提供给您。当您将鼠标悬停在方法/类名称上时,可以看到这一点。

我会熟悉Java文档,尤其是如果其他人会看您的代码时。 There are quite a few Java tags