觀念

架構(Architecture)

概念 定義
分析儀 一個分析程式碼以計算快照(snapshots)的客戶端應用程式。
資料庫 儲存組態檔(configuration)和快照(snapshots)
伺服器 用於瀏覽快照(snapshot)數據並進行組態檔(configuration)更改的 Web 介面。

另請參見 SonarQube Platform Overview

品質(Quality)

概念 定義
程式錯誤(Bug) 代表程式碼中有問題。如果這個問題還沒發生,它非常可能在最壞的時機出現。這問題需要在今天解決。
代碼異味(Code Smell) 程式碼中羽可維護性相關的問題。維護人員將會花費更多的時間在程式碼修改上,為了讓程式碼照著原意保留。最糟糕的是,維護人員會對程式碼的狀態感到困,以至於可能在進行修改時引入其他錯誤。
成本(Cost) 請參閱修復費用
負債(Debt) 請參閱技術負債(Technical Debt)
問題(Issue) 如果一段程式碼不符合規則,則會在快照(snapshot)上記錄問題。可以在原始檔案(source file)或單元測試文件(unit test file)上記錄問題。共有 3 種類型的問題:程式錯誤(Bugs), 代碼異味(Code Smells)漏洞(Vulnerabilities)
測量(Measure) 給予文件或專案在給定時間內的度量(metric)值。例如,MyClass 類別中的 125 行程式碼或 myProject 專案中重複的程式碼密度為 30.5%。
度量(Metric) 一種測量方式。度量隨著時間的變化可以有變化的值或測量值(measures)。舉例:程式碼行數、複雜度等。度量可以是 定性的(qualitative)(對元件給予品質指示、重複程式碼的 EG 密度(E.G. density)或執行程式的覆蓋率等)或 定量的(quantitative) (對元件不給予品質指示、EG 的程式碼行數、複雜度等。)
新程式碼期限(New Code Period) 在這段時間內,您將密切關注程式碼中新問題的發生。理想情況下,這是從先前版本開始的,但是如果您不使用類似 Maven 的版本控制工具,則可能需要設定一個相對隨意的時間週期,例如 21 天或自某個特定日期開始。
品質規則組合(Quality Profile) 一套規則(rules)。每個快照(snapshot)均基於單個品質規則組合。另請參閱 品質規則組合(Quality Profile)
規則(Rule) 應遵循的撰寫程式碼標準或慣例。不遵守程式碼撰寫規則會導致程式錯誤(Bugs)漏洞(Vulnerabilities)安全熱點(Security Hotspots)代碼異味(Code Smells)。規則可以檢查程式碼檔或單元測試的品質。
修復成本(Remediation Cost) 解決漏洞和可靠性問題所需的估計時間。
快照(Snapshot) 在給定時間針對給予專案的一組測量值(measures)問題(Issue)。將為每個分析生成快照。
安全熱點(Security Hotspot) 需要手動檢查的安全敏感程式碼片段。通過查看,您會發現沒有威脅,或者存在需要修復的易受攻擊的程式碼。
技術負債(Technical Debt) 解決所有可維護性問題(Maintainability Issues)/代碼異味(code smells)所需的估計時間。
漏洞(Vulnerability) 與安全相關的問題,代表攻擊者的後門。另請參閱 安全性相關的規則(Security-related rules).