StyleCop: 스타일로 코드 만들기

프로그래머 팀의 토론은 항상 당신이 인코딩해야 하는 스타일입니다.대부분의 경우, 두 명의 프로그래머가 다른 방식과 같은 방식으로 코드를 작성하지 않는다.이것은 방법 자체가 아니라 품위 문제이기 때문이다.
우리 팀은 우리가 코딩 스타일을 전문적으로 심사하는 사람이 있다고 가정해 봅시다. 상당히 무미건조합니다. 그렇죠?이것이 바로 우리가 스타일캅과 같은 자동화 도구를 사용할 수 있는 곳이다.

스타일캅이 뭐예요?

스타일캅이 뭐예요?
Style Copy는 C 코드를 해석하여 스타일과 일치성 규칙을 코드에 적용합니다.우리는 스타일캅이 두 가지 버전이 있다는 것을 기억해야 한다.최근까지는 Style Copy를 사용했지만 현재는 Style Copy Analyzer를 사용하는 것을 권장합니다. 이전 버전에서는 큰 변경이나 새로운 기능이 없었기 때문입니다.
Style Copy를 사용하여 해결할 수 있는 문제의 예시를 살펴보겠습니다.

if(condition) return;

이 도구는 예시 첫 번째 부분에서 설명한 모든 위치를 식별하고 컴파일할 때 스타일 규칙에 부합되지 않는 코드가 있음을 알려 줍니다.
돌이켜 보면, 이 규칙들은 반드시 팀의 동의를 받아야 한다.기본적으로 StyleCop는 많은 규칙을 가져왔다. 예를 들어 빈칸의 수량, 속성, 변수, 방법의 이름을 어떻게 설명하는지. 그러나 우리는 이 모든 규칙을 좋아하지 않을 수도 있고 우리 팀에도 적합하지 않을 수도 있다.

Style Copy 구성

Style Cop를 추가하는 프로젝트를 만든 후 Nuget 패키지에서 완료해야 합니다.이를 위해 프로젝트를 마우스 오른쪽 단추로 클릭하고 "Nuget Package Manager"를 선택하면 판매가 시작됩니다.검색엔진에서 우리는 스타일캅을 작성할 것이다.분석기와 압축기.다음 애니메이션에서 볼 수 있습니다.

완벽했어우리는 이미 우리의 프로젝트에서 그것을 제공했다.

Style Copy는 어떻게 사용합니까?

우리가 해야 할 첫 번째 일은 다음과 같은 코드로 우리의 주요 방법을 수정하는 것이다.

using System;

namespace StyleCopDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            HelloWorld1();
            HelloWorld2();
            HelloWorld3();

            Console.ReadLine();
        }

        private static void HelloWorld1()
        {
            Console.WriteLine("Hello World! 1");
        }

        private static void HelloWorld2()
        {
            Console.WriteLine("Hello World! 2");
        }
        private static void HelloWorld3()
        {
            Console.WriteLine("Hello World! 3");
        }
    }
}

오류 목록 창에서 StyleCop Analyzer SA 코드로 시작하는 오류가 경고 부분에 나타납니다.

만약 우리가 코드를 클릭한다면, 이 오류가 무엇 때문에 일어났는지, 그리고 규칙에 대응하는 정보를 촉발하고, 경고를 없애기 위해 코드를 어떻게 복구해야 하는지를 설명하는 작은 기교가 있다.

구성 규칙

코드에 적용될 규칙을 설정하기 위해서 우리는 두 가지 경로가 있습니다.첫 번째 방법은 [규칙] 패널에서 프로젝트를 마우스 오른쪽 버튼으로 클릭하고 [속성]을 선택하여 묻는 것입니다.두 번째는 stylecop을 추가하는 것입니다.프로젝트의 json 파일입니다.
첫 번째 규칙 패널을 보려면 솔루션 자원 관리자에 들어가서 의존 항목, 분석기를 표시하고 마지막으로 StyleCope를 선택해야 합니다.분석기.

오류, 경고, 제안, 침묵 또는 없음 사이의 심각도 수준을 구성할 수 있습니다.

각 옵션마다 다른 결과가 있습니다. 가장 중요한 것은 다음과 같습니다.

경고 섹션의 오류 목록에 나타납니다.
* 오류, 잘못된 코드가 편집기에서 빨간색으로 강조 표시되어 항목 컴파일을 막습니다.
* 보안 기능은 권장 섹션에 나타납니다.
* 없음, 규칙을 확인하지 않습니다.

규칙을 설정하는 또 다른 방법은 stylecop을 사용하는 것이다.json 파일.우리는 규칙에 따라 자동으로 그것을 만들 수 있다.표시등이 표시되면 "Add Style Cops setting..."을 누르고 선택합니다.규칙을 사용하여 파일을 생성합니다.

우리가 제정한 규칙은 문서 책임자로서의 판권과 관련이 있다.우리 JSON 파일에서 "companyName"에서 "Style Copy DEMO"로 완성합니다.다음 단계는 이 파일을 추가 해상도 파일로 추가하는 것입니다.이를 위해, 우리는 파일의 속성으로 돌아가서 설정 작업에서 그것을 설정해야 한다.규칙을 적용하면 새 회사 이름을 설정하는 방법을 볼 수 있습니다.

지금 우리는 우리가 표시하고 있는 것을 사용할 수 있다.이 규칙 중 하나에 따라 모든 using은 이름 공간에서 선언해야 합니다.

이 줄을 변경하고 사용된 줄을 이름 공간에 보존하려면 설정 파일에 규칙을 추가할 수 있습니다.

'orderingRules': {
     'usingDirectivesPlacement': 'outsideNamespace'
 }

모든 규칙을 보려면 우리는 상응하는 문서를 찾아볼 수 있다.그러나 거의 항상 기본 규칙은 모든 기본과 표준 수요를 포함한다.
마지막으로 예를 하나 더 살펴보겠습니다.

public class Customers {
     public string _name;
}

우리는 몇 가지 규칙을 준수하지 않는 종류가 있다.우선, 우리는 하나의 C 코드 파일에 여러 개의 유일한 유형이 포함되어 있다는 규칙이 있다.규칙을 실행하면 유형이 새 c# 파일로 이동합니다.그 다음으로 우리는 유형 형식 규칙이 있다.셋째, 마지막으로 클래스에 대해 기록을 해야 한다는 것이 아니라 우리가 이렇게 하고 싶지 않다고 가정하면 이상을 추가할 수 있다. 그러면 그것을 고려하지 않을 것이다.

결론

우리는 항상 팀과 우리가 집행하고자 하는 법규와 그들이 이 법규를 준수하지 않는 심각성을 합의해야 한다.따라서 가장 좋은 방법은 스타일캅이 초기 설정만 하면 우리를 위해 일을 완성할 수 있도록 하는 것이다.이 안내서는 상당히 간단하지만, 이 우수한 도구에 대한 더 많은 정보를 계속 연구해 주십시오.