需要再写19条评论行才能达到25.0％评论密度的最小阈值

Question

我是声纳工具的新手，从下面的代码中，声纳工具及其显示的内容正变得越来越重要，如下面的屏幕快照所示。

如果我在每个setter和getter方法上添加注释，问题将解决。有人可以指导我吗

代码

public class Address implements Serializable {

    private static final long serialVersionUID = 1L;

    private String addressLine1;
    private String addressLine2;
    private String city;
    private String state;
    private String zip;
    private String country="USA";

    private String addressType;

    public String getAddressLine1() {
        return addressLine1;
    }
    public void setAddressLine1(String addressLine1) {
        this.addressLine1 = addressLine1;
    }
    public String getAddressLine2() {
        return addressLine2;
    }
    public String getZip() {
        return zip;
    }
    public void setZip(String zip) {
        this.zip = zip;
    }
    public void setAddressLine2(String addressLine2) {
        this.addressLine2 = addressLine2;
    }
    public String getCity() {
        return city;
    }
    public void setCity(String city) {
        this.city = city;
    }
    public String getState() {
        return state;
    }
    public void setState(String state) {
        this.state = state;
    }   
    public String getCountry() {
        return country;
    }
    public void setCountry(String country) {
        this.country = country;
    }
    public String getAddressType() {
        return addressType;
    }
    public void setAddressType(String addressType) {
        this.addressType = addressType;
    }
}

Answer 1

需要25％的评论密度是一个糟糕的指标，因为a）它要求开发人员在仅浪费空间并使代码反常地变得晦涩难懂的地方写评论，并且b）鼓励开发人员专注于实现指标，而不是思考实际需要将哪些信息传达给其他编码人员。

您的第一步应该是提高对此问题的认识，例如G。与负责运行SonarQube服务器的人员联系，或与其他开发人员或类似人员讨论此规则的敏感性。如果付出了合理的努力并没有改变此规则，请忽略它，或者如果您必须这样做，请在代码中填充过于冗长的注释，例如有关邮政编码的五行解释（我实际上已经在此看到了公司环境）。

这不是good做法，但是，嘿，如果您的雇主有愚蠢而武断的规则要求您使您的代码不太简洁，那么，如果他们得到了他们想要的东西，那是他们自己的错。

（（我在另一个答案中提出了这个要点，但由于不愿以幽默感来解决企业文化的常见问题，所以被人下地狱了。至少我有删除该答案的徽章，所以，是的，我想。 ）