規(guī)則“公共類型、方法和字段 (API) 應(yīng)使用 Javadoc 進(jìn)行記錄”似乎在 SonarQube 6.5 中不起作用。我激活了 Java 質(zhì)量配置文件中的規(guī)則,將配置文件設(shè)置為默認(rèn)配置文件,并通過mvn sonar:sonar命令運(yùn)行我的 Java 代碼庫。它沒有發(fā)現(xiàn)任何違反此規(guī)則的行為,即使某些方法缺少 Javadoc。其他規(guī)則可以很好地發(fā)現(xiàn)違規(guī)行為。我的測(cè)試課是這樣的:package counter;/** * This is a Javadoc comment */public class MyClass { public static final int DEFAULT_STATUS = 0; // Compliant - static constant private int status; // Compliant - not public public String message; // Noncompliant public MyClass() { // Noncompliant - missing documentation this.status = DEFAULT_STATUS; } public void setStatus(int status) { // Compliant - setter this.status = status; } protected int doSomething() { return status + 24;// Compliant - not public } public int doSomething2(int value) { // Noncompliant int a = value*8; return a*1; } public int doSomething3(int value) { // Noncompliant return value*9; }}
2 回答

HUX布斯
TA貢獻(xiàn)1876條經(jīng)驗(yàn) 獲得超6個(gè)贊
你可以做的是升級(jí)到 SonarQube 6.7.7,更新所有插件,檢查使用的配置文件中規(guī)則的激活,然后再試一次。請(qǐng)注意,最新的 LTS 版本是 7.9,因此您應(yīng)該準(zhǔn)備從 6.7.x 升級(jí)到下一個(gè)主要版本 7.9。也再次更新插件。

神不在的星期二
TA貢獻(xiàn)1963條經(jīng)驗(yàn) 獲得超6個(gè)贊
終于明白了。在默認(rèn)設(shè)置下,UndocumentedAPI
規(guī)則僅適用于 api 包(api
名稱中包含的包)。
在規(guī)則激活期間,提示菜單會(huì)詢問應(yīng)運(yùn)行此規(guī)則的類模式。如圖所示:
現(xiàn)在我們可以根據(jù)需要輕松更改此設(shè)置。
添加回答
舉報(bào)
0/150
提交
取消