code-prettify

2014年7月25日 星期五

C# StyleCop 忽略特定錯誤訊息

雖然 StyleCop 蠻方便的,但是有時候難免會出現誤報,
像是這一行 IPHostEntry ipHostInfo = Dns.GetHostEntry(Dns.GetHostName());
ipHostInfo 就被判定為匈牙利命名法 (Hungarian notation),
這時候只能換另一個變數命名,
或者,使用 Suppress 忽略掉這個錯誤訊息。

在這個函式上方加上這一行
[SuppressMessage("StyleCop.CSharp.NamingRules", "SA1305:FieldNamesMustNotUseHungarianNotation", Justification = "Reviewed.")]
就可以忽略掉這一個錯誤訊息。

至於每一次 StyleCop Rule 的 Suppress 要怎麼寫,
可以參考 StyleCop Rules Documentation ,
除了 Rule Suppressions 的說明之外,每個 Rule 最下方也有該 Rule 的Suppress 方法。
像是這次遇到的 SA1305 FieldNamesMustNotUseHungarianNotation 就是從這裡來的。

Reference
StyleCop
StyleCop Rules Documentation


沒有留言:

張貼留言