| 房產 | 價值觀 |
|---|---|
| 規則識別碼 | 約1877年 |
| 標題 | 使用 Path.Combine 或 Path.Join 超載 |
| 類別 | 效能 |
| 修正是破壞性或非破壞性 | Non-breaking |
| 在 .NET 10 中預設啟用 | 建議 |
原因
使用多個連續 Path.Combine 的 or Path.Join 作業來建置路徑。
規則描述
當您使用多個連續 Path.Combine 或 Path.Join 作業時，使用接受多個路徑區段的多載會更有效率。 這種方法減少了分配和函數呼叫的次數，提高了效能。 這兩種方法都提供接受多個參數的重載，可讓您將連續的操作折疊為單一呼叫。
如何修正違規
使用接受所有路徑區段的多載，將連續的 Path.Combine or Path.Join 作業取代為單一呼叫。
可以使用自動執行此轉換的 程式碼修正程式 。
Example
下列程式碼片段顯示違反 CA1877：
public string GetFilePath(string folder, string subfolder, string filename)
{
// Violation.
string temp = Path.Combine(folder, subfolder);
return Path.Combine(temp, filename);
}
public string GetLogPath(string baseDir, string date, string category)
{
// Violation.
return Path.Join(Path.Join(baseDir, date), category);
}
Public Function GetFilePath(folder As String, subfolder As String, filename As String) As String
' Violation.
Dim temp As String = Path.Combine(folder, subfolder)
Return Path.Combine(temp, filename)
End Function
Public Function GetLogPath(baseDir As String, [date] As String, category As String) As String
' Violation.
Return Path.Join(Path.Join(baseDir, [date]), category)
End Function
下列程式碼片段可修正違規：
public string GetFilePath(string folder, string subfolder, string filename)
{
// No violation.
return Path.Combine(folder, subfolder, filename);
}
public string GetLogPath(string baseDir, string date, string category)
{
// No violation.
return Path.Join(baseDir, date, category);
}
Public Function GetFilePath(folder As String, subfolder As String, filename As String) As String
' No violation.
Return Path.Combine(folder, subfolder, filename)
End Function
Public Function GetLogPath(baseDir As String, [date] As String, category As String) As String
' No violation.
Return Path.Join(baseDir, [date], category)
End Function
隱藏警告的時機
如果效能不是問題，則可以安全地隱藏此規則中的警告。
隱藏警告
如果您只想要隱藏單一違規，請將預處理器指示詞新增至原始程式檔以停用，然後重新啟用規則。
#pragma warning disable CA1877
// The code that's violating the rule is on this line.
#pragma warning restore CA1877
若要停用檔案、資料夾或項目的規則，請在組態檔
[*.{cs,vb}]
dotnet_diagnostic.CA1877.severity = none
如需詳細資訊，請參閱 如何隱藏程式碼分析警告。
