從SonarQube審查中隱藏Docco的評論代碼

Question

我們的組織正在使用SonarQube來管理代碼質量，以及Docco處理來自代碼註釋的文檔生成。

我們遇到了在Docco的註釋中包含諸如方法名稱之類的東西之間的衝突，並且在SonarQube中不應該將「代碼段」評論爲「註釋掉」規則。

是否有任何已知的最佳實踐讓SonarQube忽略用於文檔的註釋中的代碼（即使對於Docco尤其更好），同時仍捕獲已被註釋掉而不是被移除的舊代碼？

Answer 1

可以簡單地在與您的項目相關的質量配置文件中禁用「代碼段不應被註釋掉」的規則。