practical csharp
1.0.0
クリーンで読みやすく、理解しやすく、保守可能なC＃コードを書くための、主に合理的なガイドラインとベストプラクティスのコレクション。
varを使用してください目的：読みやすさと清潔さの向上
良い
var httpClient = new HttpClient ( ) ;悪い
HttpClient httpClient = new HttpClient ( ) ; 目的：読みやすさと清潔さの向上
良い
var user = new User
{
Username = "admin" ,
Age = 31
} ;悪い
var user = new User ( ) ;
user . Username = "admin" ;
user . Age = 31 ; string.Formatの代わりに文字列補間を使用します目的：読みやすさとセマンティクスを改善します
良い
var url = "http://localhost/api" ;
var resource = "users" ;
var path = $ " { url } / { resource } " ;悪い
var url = "http://localhost/api" ;
var resource = "users" ;
var path = string . Format ( "{0}/{1}" , url , resource ) ;目的：バックスラッシュキャラクターを逃れる必要はありません
良い
var path = @"C:UsersAdministratorDocuments" ;悪い
var path = "C: \ Users \ Administrator \ Documents" ;目的：リファクタリングは、文字列リテラルが何度もあちこちに配布されると悪夢になる可能性があります
良い
const string error = "user_not_found" ;
Log . Error ( error ) ;
return BadRequest ( error ) ;悪い
Log . Error ( "user_not_found" ) ;
return BadRequest ( "user_not_found" ) ; xyzに名前を付けて時間を節約しているとは言わないでください。それはただばかげています。目的：変数名の短縮は価値を追加しません。コードは読み取りと理解がより難しくなります
良い
// Nice
var validationResult = validator . Validate ( ) ;
// Nice
var stringBuilder = new StringBuilder ( ) ;
// Nice
const string directorySeparator = "/" ;悪い
//
var res = validator . Validate ( ) ;
//
var sbd = new StringBuilder ( ) ;
// Seriously?
const string dsep = "/" ;目的：コードの読み取り、保守、作業が非常に簡単になります
良い
// The purpose of this class can be easily inferred
public class OrderManager
{
// Using "Is" or "Has" as prefix clearly indicates that a method returns a boolean value
public bool IsFulfilled ( Order order )
{
}
public bool HasPositions ( Order order )
{
}
// Using a verb clearly indicates that a method performs some action
public void ProcessOrder ( Order order )
{
}
public void CancelOrder ( Order order )
{
}
}悪い
// Purpose of this class can not be easily inferred
public class OrderHelper
{
// Unclear
public bool Fulfilled ( Order order )
{
}
// Unclear => users would likely expect a method that retrieves the positions of the order due to the verb "Get"
public bool GetPositions ( Order order )
{
}
// Unclear
public void Order ( Order order )
{
}
// Unclear
public void StopOrder ( Order order )
{
}
}目的：コードを不必要に長く読み、理解するのが難しくなります
良い
// Clearly an interface
public interface IOrderManager { }
// Clearly a list of orders
private IList < Order > orders ;悪い
// Clearly an interface => no "Interface" postfix necessary
public interface IOrderManagerInterface { }
// Clearly a list of oders => no "List" postfix necessary
private IList < Order > orderList ;目的：練習は、コードベースが成長して進化するにつれて、コメントが非常に簡単かつ迅速に時代遅れになる可能性があることを示しています。自明のコードベースを持つことは、より良いメンテナビリティに貢献し、不信心なコメントを書いて維持する必要性を減らします。 （これは、コメントを書くことが時代遅れであるという意味ではありません。）
良い
public class OrderManager
{
public void ProcessOrder ( Order order )
{
var items = order . GetItems ( ) ;
foreach ( var item in items )
{
var availability = item . GetAvailability ( ) ;
}
}
}悪い
public class OrderManager
{
public void ExecuteOrder ( Order order )
{
// Get all available items from the order
var data = order . GetData ( ) ;
foreach ( var x in data )
{
// Determine the availability of the item
var available = item . CheckAvailability ( ) ;
}
}
}目的：.NETフレームワークと一致し、読みやすい
良い
public class JsonParser { }悪い
public class JSONParser { }目的： enumは常に個別に対処されます。たとえば、 EmploymentType.FullTime 、 EmploymentTypes.FullTimeよりもはるかにクリーンです。さらに、クラスは常に、個々のUserなど、オブジェクトの単一インスタンスを表します。例外：ビットフィールドエナム
良い
public enum EmploymentType
{
FullTime ,
PartTime
}
public class User
{
}悪い
public enum EmploymentTypes
{
FullTime ,
PartTime
}
public class Users
{
} 目的：SyntacticSugar¯ （ツ） /¯
良い
public class User
{
public string Username { get ; }
public int Age { get ; }
public string DisplayName => $ " { Username } ( { Age } )" ;
public User ( string username , int age )
{
Username = username ;
Age = age ;
}
}悪い
public class User
{
public string Username { get ; }
public int Age { get ; }
public string DisplayName
{
get
{
return $ " { Username } ( { Age } )" ;
}
}
public User ( string username , int age )
{
Username = username ;
Age = age ;
}
} 目的：何がうまくいかなかったかについてのより良い認識。ロギングおよびエラー分析中に、より精度が高まります。
良い
try
{
System . IO . File . Open ( path ) ;
}
catch ( FileNotFoundException ex )
{
// Specific
}
catch ( IOException ex )
{
// Specific
}
catch ( Exception ex )
{
// Default
}悪い
try
{
System . IO . File . Open ( path ) ;
}
catch ( Exception ex )
{
// SOMETHING went wrong
}Exceptionを常に使用してください。目的：非常に悪い練習。 Exception Sは、.NETフレームワークによってのみスローされる必要があります。
良い
public void ProcessOrder ( Order order )
{
if ( order == null )
{
throw new ArgumentNullException ( nameof ( order ) ) ;
}
}悪い
public void ProcessOrder ( Order order )
{
if ( order == null )
{
throw new Exception ( "Order is null." ) ;
}
} 目的：読みやすさを改善します
良い
private string _username ;悪い
private string mUsername__ ;
// OR
private string username ;
// OR
private string username_ ; 目的：読みやすさを改善し、スペースを節約します
良い
public class JsonParser
{
private readonly string _json ;
public JsonParser ( string json )
{
_json = json ;
}
}悪い
public class JsonParser
{
private readonly string _json ;
public JsonParser ( string json )
{
_json = json ;
}
} 目的：財産が誤って他の場所から変更されるのを防ぎ、アプリケーションの動作のより良い予測
良い
public class JsonParser
{
public string Json { get ; }
public JsonParser ( string json )
{
Json = json ;
}
}悪い
public class JsonParser
{
public string Json { get ; set ; }
public JsonParser ( string json )
{
Json = json ;
}
}目的：コレクションが他の場所から変更されるのを防ぎ、アプリケーションの動作のより良い予測
良い
public class KeywordProvider
{
public IReadOnlyCollection < string > Keywords { get ; }
public KeywordProvider ( )
{
Keywords = new ReadOnlyCollection < string > ( new List < string >
{
"public" ,
"string"
} ) ;
}
}悪い
public class KeywordProvider
{
public IList < string > Keywords { get ; }
public KeywordProvider ( )
{
Keywords = new List < string >
{
"public" ,
"string"
} ;
}
} using使用してください目的： usingブロックが仕上げられたときにリソースが自動的に廃棄されます
良い
using ( var connection = new SqlConnection ( connectionString ) )
{
}悪い
try
{
var connection = new SqlConnection ( connectionString ) ;
}
finally
{
connection . Close ( ) ;
connection . Dispose ( ) ;
} 目的：条件内で別のラインが必要な場合、より良い読みやすさ、メンテナンスが容易です
良い
if ( user . IsElevated )
{
// Do something
}悪い
if ( user . IsElevated )
// Do something目的：メッセージのどの部分に変数が含まれているかを認識してください。
良い
var filePath = @"C:tmpmy-file.txt" ;
try
{
var file = File . Open ( filePath ) ;
}
catch ( Exception ex )
{
// GOOD: Add [ ] to the variable
Log . Error ( $ "Could not open file [ { filePath } ]." , ex ) ;
}悪い
var filePath = @"C:tmpmy-file.txt" ;
try
{
var file = File . Open ( filePath ) ;
}
catch ( Exception ex )
{
Log . Error ( $ "Could not open file { filePath } ." , ex ) ;
}目的：特定の場合に例外をフィルタリングできるように（たとえば、ユーザーインターフェイスでは、スタックトレース全体がユーザーにとって役に立たないため）。
良い
try
{
var file = File . Open ( @"C:tmpmy-file.txt" ) ;
}
catch ( Exception ex )
{
// Use appropriate signature of your logger to include the exception as separate parameter
Log . Error ( "Could not open file." , ex ) ;
}悪い
try
{
var file = File . Open ( @"C:tmpmy-file.txt" ) ;
}
catch ( Exception ex )
{
// Strictly AVOID this. The exception is added directly to the log message, which makes it impossible to filter the exception
Log . Error ( $ "Could not open file: { ex } " ) ;
}
