Vscode автозаполнение для получения и установки информации

Question

При использовании 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;
    }

Что было бы более правильным? И что означает комментарий в первом?

Answer 1

Я не верю, что существует соглашение для имен параметров в методах получения и установки. Так что технически они оба верны. Хотя я всегда использовал ваш первый пример, даже когда я не генерирую свои методы автоматически, и вы обнаружите, что большинство кода с открытым исходным кодом Java будет использовать ваш первый пример.

Ваш комментарий - javado c. Инструменты сборки, такие как Maven и Gradle, предоставляют возможность составления документации API . IDE (например, VSCode) также проанализирует javado c и предоставит его вам динамически. Это можно увидеть в действии, когда вы наводите курсор на имена методов / классов.

Я бы познакомился с документацией Java, особенно если кто-то еще посмотрит на ваш код. Есть довольно много Java тегов .