당신의 C # 코드를 개선하기 위해 6 깐깐한 방법

아무것도 저에게 쓰레기 코드를 파헤쳐야만보다 더 irks 없습니다. 소프트웨어 컨설팅 회사에서 일하고, 나는 그것의 전체 슬루 봤어요. 그리고 나는 그것을 매우, 갈색과 녹색 색조를주는 결과로 충분히 모니터링할 컴퓨터에 hurled했습니다. 잘못된 코드는 하드웨어를 파괴합니다. 그리고 영혼.

개발자 중 그들이 무엇을하는지 모르고있다거나 단순히 코드 관심도없는 것이 가장 큰 하나의 단서가 모순이다. 우리 모두는 서로 다른 환경과 코딩 스타일을 가지고 있지만, 개발자들이 같은 매우 아마추어 잘라야 걸릴 특정 접근 방식을 선택할 수 없을 때, 그리고 좋은 이유. 일관성 코드를 읽기가 어렵습니다, 그리고 나중에 수정해야하므로 어렵습니다.

아래 목록의 대부분 (혹은 전체)가 일관되게 스타일과 일관 C # 코드를 수행 쓰기를 중심으로 돌아가지는 않습니다. 대부분이 목록을보다시피 항문 까탈 쟁이이지만, 모두 코드의 품질과 가독성을 향상시키기 위해 보장됩니다.

1. Visual Studio에서 코드 분석 기능을 사용합니다.

당신 빠르게 처음들을 사용하기 시작할 때 발견으로 코드 분석 기능은, 자연에 의해 보유하는 항문입니다. 그들은 금을 자기 몸무게의 가치도하지만, 복이 있나니 저희가 귀하의 C # 코드를 개선하는 데 가장 즉각 효과적인 방법입니다.

당신의 코드를 만들 때마다 코드 분석 "모범 사례"의 크고 성장하는 목록을 충족하고 있으며, 그렇지 않은 경우 오류 목록에서 경고를 만들 것이라고 확신하고 그것을 검사합니다. 그것을 훌륭하게 비주얼 스튜디오의 코드 분석을 통과하지 않으면 당신은 당신의 코드 "좋은"코드를 호출할 수 없습니다. 가이 규칙에 예외가 있지만 그들은 극소수입니다.

당신의 C # Visual Studio 2005 또는 2008 프로젝트에서 코드 분석을 활성화하면 Windows 또는 웹 응용 프로그램과 함께 최선을 다하고 있는지에 따라 달라집니다.

Windows 응용 프로그램 내용은 솔루션 탐색기로 이동하여 프로젝트의 속성 노드를 두 번 누릅니다. 여기에서 왼쪽에있는 코드 분석 탭을 선택합니다. 빌드 확인란 사용 코드 분석을 확인하고, 당신의 방식이있어. 당신이 사용하고 개별적으로 각종 검사를 비활성화할 수 있습니다는 것을 알 수 있지만, 난 당신이 당신이 무시할 수 있는지 있다고 경고를 찾았 않는 한 그들 모두 체크 떠나는 것이 좋습니다. 제가 이전에 언급한 적이 있듯이, 코드 분석은 거의 항상 옳다.

웹 응용 프로그램 내용은 솔루션 탐색기로 이동하여 귀하의 웹사이트의 루트 노드를 선택합니다. 그런 다음 분석 메뉴로 가서 코드 분석 구성을 선택합니다. 여기에서 빌드 확인란 사용 코드 분석을 확인하고 당신의 방식이있어.

2. 일관성 있고 효과적으로 영역을 사용합니다.

아무도 특정한 방법을 찾기 위해 엄청난 코드 파일을 통해 파고 좋아하지 않아 및 C #의 영역이 문제를 해결하기 위해 도움이됩니다. 다음은 예제입니다 :

#region Private Variables

private int x;
private int y;

#endregion

#region Public Properties

public int X
{
    get
    {
        return x;
    }
}

public int Y
{
    get
    {
        return y;
    }
}

#endregion

In Visual Studio, regions can be collapsed or expanded using the +/- buttons to the left of the region names in the code window. This helps to make it much easier to find a particular method you are looking for. There are many ways to organize your code with region statements, but I prefer to separate the code by type of construct (variables, constructors, event handlers, methods, properties, etc.) and access modifier (public, internal, protected, or private).

3.  Handle white space consistently.

C# ignores white space, which means you can put extra spaces and lines pretty much wherever you like.  Or, if you’re insane, you can jam ten-thousand lines of code into a very angry single line of actual text, separated only by semicolons.

Here are a few things to consider, though:

• Code with more white space is generally much easier to read.  Less condensed code is easier on the eyes and with screen real estate being as ample as it is these days, there’s little reason to try and jam your code into as few lines as possible.  For the most part, bigger is better.
• Even though code blocks, such as if and while statements, do allow you to omit the curly braces, this generally makes your code harder to read.  The general consensus is to always use curly braces even when there is only one line of code you are executing between them.
• Consistency, consistency, consistency.  If you put new lines after you close blocks of code, be sure you do it everywhere.  Don’t “feel it out.”  Come up with your own strategy (preferably similar or the same to most other peoples’ strategies) and stick to it.

4.  Always specify your access modifiers and choose them carefully.

C# access modifiers are simply the public, internal, protected, and private keywords that you typically place in front of variables, properties, and methods.  Though these are often overlooked, they provide meaning to the functionality behind your code and help to better define the structure of your code through encapsulation.

Here are some grossly oversimplified definitions and uses for the four modifiers.  These definitions are lacking some detail, but should be plenty of information to handle the vast majority of circumstances:

Private members are only accessible to the class in which they live.  All variables, properties, methods, etc. that do not need to be accessed outside the immediate class should be marked as private.

Protected members are accessible to the class in which they live, as well as any classes that derive from (extend) the class.  The protected modifier should be used on variables, properties, methods, etc. that may need to be accessed by classes that may derive from (extend) the current class.

Internal members are accessible everywhere within the current project, but are inaccessible by other projects that might reference the current project.  In other words, using the internal modifier specifies that only classes within the current EXE or DLL file can access the member.  The internal modifier should be used on all variables, properties, methods, etc. that need to be available to other classes within the project, but should not be available outside the project.

Public members are accessible everywhere, period.  There are no restrictions to their access.  This particular modifier is often overused, as the internal modifier is overlooked.  The public modifier should only be used for members or classes that are or would possibly be needed outside of the current project.

As far as defining classes, typically only internal or public are used, depending on if they need to be accessible outside the project.  This, however, does not account for nested classes, which can have any of the four access modifiers.  Always specify your access modifiers to avoid confusion as to when and where the class or member can be used.

5.  Learn the ways to properly use exceptions and stick to them.

C# exceptions are extremely powerful and convenient, but when used incorrectly, they can both slow your application down and hinder output to the end user.

There are two basic rules of thumb to using exceptions properly:

• Never catch an exception when you can check for and prevent the error instead.  A typical scenario is trying to open a file that you’re not entirely sure really exists.  You can wrap the file open code in a try catch, or you can use File.Exists to determine if the file exists before attempting to open it.  Exceptions in C# are expensive, so you only want an exception to be raised if a true error occurs.  If you can predict that it might happen for a particular reason, you should be able to check to make sure that it won’t happen before proceeding.  This will help to improve performance significantly.
• Also, never catch the root Exception class, or any high-level, broad exception.  If you catch an Exception class, and you incorrectly assume that the user didn’t fill in a particular field as a result, the user will see your incorrect error message and be unable to see the actual error that occurred.  This is unacceptable.  Instead, research the methods you are ca 다음은 예제입니다 :

  
  #region Private Variables
  
  private int x;
  private int y;
  
  #endregion
  
  #region Public Properties
  
  public int X
  {
      get
      {
          return x;
      }
  }
  
  public int Y
  {
      get
      {
          return y;
      }
  }
  
  #endregion
  

  In Visual Studio, regions can be collapsed or expanded using the +/- buttons to the left of the region names in the code window. This helps to make it much easier to find a particular method you are looking for. There are many ways to organize your code with region statements, but I prefer to separate the code by type of construct (variables, constructors, event handlers, methods, properties, etc.) and access modifier (public, internal, protected, or private).

  3.  Handle white space consistently.

  C# ignores white space, which means you can put extra spaces and lines pretty much wherever you like.  Or, if you’re insane, you can jam ten-thousand lines of code into a very angry single line of actual text, separated only by semicolons.

  Here are a few things to consider, though:

  • Code with more white space is generally much easier to read.  Less condensed code is easier on the eyes and with screen real estate being as ample as it is these days, there’s little reason to try and jam your code into as few lines as possible.  For the most part, bigger is better.
  • Even though code blocks, such as if and while statements, do allow you to omit the curly braces, this generally makes your code harder to read.  The general consensus is to always use curly braces even when there is only one line of code you are executing between them.
  • Consistency, consistency, consistency.  If you put new lines after you close blocks of code, be sure you do it everywhere.  Don’t “feel it out.”  Come up with your own strategy (preferably similar or the same to most other peoples’ strategies) and stick to it.

  4.  Always specify your access modifiers and choose them carefully.

  C# access modifiers are simply the public, internal, protected, and private keywords that you typically place in front of variables, properties, and methods.  Though these are often overlooked, they provide meaning to the functionality behind your code and help to better define the structure of your code through encapsulation.

  Here are some grossly oversimplified definitions and uses for the four modifiers.  These definitions are lacking some detail, but should be plenty of information to handle the vast majority of circumstances:

  Private members are only accessible to the class in which they live.  All variables, properties, methods, etc. that do not need to be accessed outside the immediate class should be marked as private.

  Protected members are accessible to the class in which they live, as well as any classes that derive from (extend) the class.  The protected modifier should be used on variables, properties, methods, etc. that may need to be accessed by classes that may derive from (extend) the current class.

  Internal members are accessible everywhere within the current project, but are inaccessible by other projects that might reference the current project.  In other words, using the internal modifier specifies that only classes within the current EXE or DLL file can access the member.  The internal modifier should be used on all variables, properties, methods, etc. that need to be available to other classes within the project, but should not be available outside the project.

  Public members are accessible everywhere, period.  There are no restrictions to their access.  This particular modifier is often overused, as the internal modifier is overlooked.  The public modifier should only be used for members or classes that are or would possibly be needed outside of the current project.

  As far as defining classes, typically only internal or public are used, depending on if they need to be accessible outside the project.  This, however, does not account for nested classes, which can have any of the four access modifiers.  Always specify your access modifiers to avoid confusion as to when and where the class or member can be used.

  5.  Learn the ways to properly use exceptions and stick to them.

  C# exceptions are extremely powerful and convenient, but when used incorrectly, they can both slow your application down and hinder output to the end user.

  There are two basic rules of thumb to using exceptions properly:

  • Never catch an exception when you can check for and prevent the error instead.  A typical scenario is trying to open a file that you’re not entirely sure really exists.  You can wrap the file open code in a try catch, or you can use File.Exists to determine if the file exists before attempting to open it.  Exceptions in C# are expensive, so you only want an exception to be raised if a true error occurs.  If you can predict that it might happen for a particular reason, you should be able to check to make sure that it won’t happen before proceeding.  This will help to improve performance significantly.
  • Also, never catch the root Exception class, or any high-level, broad exception.  If you catch an Exception class, and you incorrectly assume that the user didn’t fill in a particular field as a result, the user will see your incorrect error message and be unable to see the actual error that occurred.  This is unacceptable.  Instead, research the methods you are calling to determine the particular types of exceptions they raise, and catch these specific exceptions.  This way, if something occurs that you didn’t expect, the end user will see the detailed error message anyway.  The MSDN documentation does a great job of providing you with all of the details you need regarding every exception that is possible for every single method in the .NET framework.

  6.  ALWAYS use using statements.

  In case you’re not familiar with the syntax of using statements, here is an example:

  
  using (StreamWriter writer = new StreamWriter("C:\\file.txt"))
  {
      writer.WriteLine("Hello!");
  }
  

  Using statements can be used wherever you’re instantiating an object that is IDisposable (can be disposed using the Dispose method).  If you don’t actively dispose objects that support the IDisposable interface, you’re asking for all sorts of performance and memory leak trouble.  Here are the advantages of using statements over calling the Dispose method directly:

  • Even if an exception is raised within your using statement block, the runtime will still ensure that the object gets properly disposed.  This is automatic with the using statement and is impossible without it.  Before using statements were added in .NET 2.0, you had to attempt to dispose of your objects within a catch block, which was far from error-prone.  Never take this approach.
  • Using statements help to visually define the scope of a variable that requires disposing.  You can quickly and easily see the start and end of the lifetime of the variable.  Once you are in the habit of consistently using using statements to dispose of objects you will very rarely (if ever) forget to dispose of an object, because of the block nature of the statement.
  • Using statements even allow you to return from a method within the statement.  The object is still disposed of properly in this situation.  In other words, if you use a using statement, the object is GUARANTEED to be disposed of despite any and all circumstances.  That’s a pretty big and valuable promise.

  There is much more to writing good C# code than these 6 rules, but these are the rules that I see consistently broken that are driving me to an early grave.  Let me know in the comments if you think I’m missing something important or disagree with any of my statements.