C#에서 코드 스니펫 생성 - 효율성을 위한 Visual Studio 맞춤화

코드 조각이 중요한 이유

Tim은 자동 속성, 생성자 및 foreach 루프와 같은 것들을 삽입하기 위해 코드 조각을 자주 사용하는 방법에 대해 이야기하면서 설명을 시작합니다. 그는 cw를 입력하고 Tab 키를 두 번 누르면 Console.WriteLine()이 삽입되어 커서가 괄호 사이에 위치하게 되는 방법을 보여줍니다. 이는 문자열 내용을 출력할 때 필수적인 요령입니다.

하지만 그가 지적했듯이 모든 유용한 메서드에 내장된 코드 조각이 있는 것은 아닙니다. 예를 들어 Console.ReadLine()에는 해당 기능이 없습니다. 팀의 반응은 어땠을까요? 직접 만들어 보세요.

Visual Studio에서 데모 프로젝트 설정하기

실제 상황을 보여주기 위해 Tim은 Visual Studio에서 ASP.NET Core 웹 애플리케이션을 설정합니다. 프로젝트 유형이 필수적인 것은 아니지만, C# 및 HTML 파일을 활용할 수 있으면 두 언어 모두의 예시를 보여줄 수 있습니다.

중요한 점은 코드 스니펫이 C#에만 국한되지 않고 HTML, XAML 등 Visual Studio에서 지원하는 여러 언어에도 적용될 수 있다는 것입니다.

내장 코드 조각과 바로 가기의 강력한 기능

Tim은 기존 코드 조각 몇 개를 보여줍니다.

• cw + Tab Tab → Console.WriteLine()

• 생성자 + 탭 탭 → 생성자

• prop + 탭 탭 → 자동 구현 속성(예: public string Test { get; 세트; })

• propfull → 백킹 필드를 사용하여 속성을 생성합니다.

이러한 단축 방법은 반복 작업을 없애고 성능을 향상시키도록 설계되었습니다. 문자열이나 정수 같은 데이터 유형과 이름을 지정하기만 하면 나머지는 자동으로 생성됩니다.

이러한 내장 코드 조각은 보간, public과 같은 접근 제한자, 시스템 정의 요소 등을 보여주어 코드가 일관된 구조를 따르도록 보장합니다.

VS Code에서 나만의 코드 조각 만들기

Tim은 코드 조각 생성 도구를 사용하는 대신, 단순성과 XML 구문 강조 기능 때문에 Visual Studio Code를 선택합니다.

그는 readline.snippet이라는 파일을 만들고 핵심적인 XML 구조를 보여줍니다.

<CodeSnippets>
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>Console.ReadLine</Title>
      <Shortcut>cr</Shortcut>
      <Description>Creates Console.ReadLine()</Description>
      <Author>Tim Corey</Author>
    </Header>
    <Snippet>
      <Code Language="csharp"><!-- [CDATA[
Console.ReadLine();
]]></Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

<CodeSnippets>
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>Console.ReadLine</Title>
      <Shortcut>cr</Shortcut>
      <Description>Creates Console.ReadLine()</Description>
      <Author>Tim Corey</Author>
    </Header>
    <Snippet>
      <Code Language="csharp"><!-- [CDATA[
Console.ReadLine();
]]></Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

이것은 기본적인 코드 조각입니다.<!-- [CDATA[]]> 원본 C# 코드를 래핑하기 위해서입니다. 이제 단축키 cr을 사용하면 Tab 키를 두 번 눌러 Console.ReadLine() 메서드가 삽입됩니다.

Tim은 서식이 사용자의 Visual Studio 환경에서 상속되므로 들여쓰기와 간격이 사용자 설정과 일치한다고 지적합니다.

Visual Studio로 코드 조각 가져오기

Tim은 도구 > 코드 스니펫 관리자를 사용하여 .snippet 파일을 가져오는 방법을 설명합니다. 그는 '내 코드 조각' 위치를 선택하여 필요할 때 코드 조각이 나타나도록 합니다.

불러오기가 완료되면 cr + Tab + Tab을 입력하여 Console.ReadLine() 줄이 삽입되고, 해당 값을 변수에 할당하거나 예외 처리 블록 내에서 사용할 수 있습니다.

재사용 가능한 문서 헤더

다음으로 Tim은 기업 프로젝트나 협업 팀에서 자주 필요한 문서화 코드 조각을 보여줍니다. 그는 단축어 docme를 사용하여 주석 블록을 생성하는 코드 조각을 만듭니다.

/// Title:
/// Author:
/// Date:
/// Purpose:

/// Title:
/// Author:
/// Date:
/// Purpose:

이는 변경 내역, 작성자 및 파일 컨텍스트를 추적하는 데 이상적입니다. Git과 같은 도구가 버전 관리를 담당하는 반면, 헤더 파일은 특히 대규모 팀에서 빠른 시각적 참조를 제공합니다.

HTML 코드 조각: 부트스트랩 폼 예제

코드 조각은 C# 코드에만 사용되는 것이 아닙니다. Tim은 HTML에서 이러한 기능을 사용하는 방법을 보여줍니다. 이는 폼, 입력 요소 및 구조화된 태그 모음을 구축하는 데 매우 유용합니다.

그는 Bootstrap 폼 예제를 복사하여 동일한 XML 코드 조각 형식으로 감싸고 언어를 HTML로 변경합니다. 가져오기 후, 바로 가기 코드인 sampleform을 입력하면 미리 만들어진 HTML 구조가 삽입되어 외부 URL을 반복적으로 참조하거나 정형화된 코드를 복사할 필요가 없습니다.

플레이스홀더와 변수를 사용한 고급 코드 조각

여기서부터는 더욱 발전되고 강력해집니다. Tim은 구성 값을 가져오는 코드 조각을 작성합니다.

_config.GetValue<string>("values:myTest");

_config.GetValue<string>("values:myTest");

그는 타입(문자열, 정수, 부울)과 경로(values:myTest) 모두에 플레이스홀더를 사용하는 방법을 보여주므로 개발자는 다른 부분만 채우면 됩니다.

XML에서 그는 다음을 사용합니다.

<Declarations>
  <Literal>
    <id>ValType</id>
    <Default>string</Default>
    <ToolTip>Data type of the value</ToolTip>
  </Literal>
  <Literal>
    <id>Path</id>
    <Default>values:myTest</Default>
    <ToolTip>Config path</ToolTip>
  </Literal>
</Declarations>

<Declarations>
  <Literal>
    <id>ValType</id>
    <Default>string</Default>
    <ToolTip>Data type of the value</ToolTip>
  </Literal>
  <Literal>
    <id>Path</id>
    <Default>values:myTest</Default>
    <ToolTip>Config path</ToolTip>
  </Literal>
</Declarations>

코드 조각 본문에서:

_config.GetValue<$ValType$>("$Path$")

_config.GetValue<$ValType$>("$Path$")

이러한 변수 및 선언의 사용은 유연하고 표현력이 풍부하며 간결한 코드 생성을 가능하게 합니다. 보안 설정 검색, 사전 접근 또는 JSON 파일에서 중첩된 값 읽기와 같은 작업에 이상적입니다.

코드 조각이 성능을 향상시키는 이유

팀은 스니펫이 단순히 속도 향상에만 도움이 되는 것이 아니라, 일관된 코드 작성 방식을 장려하고 오류를 줄이며 팀 전체의 코드 가독성을 개선하는 데에도 기여한다고 설명하며 마무리합니다. 시간이 지남에 따라, 각 코드 조각당 몇 초씩만 절약하더라도 결과적으로 몇 시간을 절약할 수 있습니다.

그는 짧은 글이 다음과 같은 데 도움이 된다고 강조합니다.

• 공통 작업 초기화

• try-catch-finally를 사용한 표준화된 예외 처리

• 전체 수업 템플릿 생성

• finally 블록, 구조화된 catch 블록 및 메서드 오버라이드 내에서 작업

결론: 개발자의 관점

복잡한 시스템을 구축하든 간단한 앱을 만들든, 코드 스니펫은 C 코드나 C# 코드를 더 빠르고 일관성 있게 작성하는 데 도움이 될 수 있습니다. 이를 통해 다음과 같은 작업을 수행할 수 있습니다.

• 반복을 없애세요

• 비즈니스 로직에 집중하세요

• 깔끔하고, 보간이 잘 되어 있으며, 문서화가 잘 된 코드베이스를 유지 관리합니다.

팀이 그의 상세한 영상 에서 제안했듯이, 자신의 코딩 습관을 살펴보세요. 같은 내용을 반복해서 입력하는 부분을 찾아보세요. 다음으로, 한 가지 접근 방식을 선택하세요: 코드 조각을 생성합니다.

곧 여러분은 워크플로우가 완전히 달라졌다는 것을 깨닫게 될 것입니다. 개발이 더욱 효율적이고 체계적이며 즐거워질 것입니다.

시작하기 좋은 간단한 코드 아이디어

• tryfinally – try + finally 블록 생성

• logerror – Log.Error()를 사용하여 로깅 로직을 삽입합니다.

• propnotify – INotifyPropertyChanged 속성을 가진 속성

• filecheck – File.Exists(path)를 인라인 로직으로 검사합니다.

• foreachdict – 딕셔너리를 순회하는 루프<TKey, TValue>

팀의 팁: 다른 파일에서 내용을 복사해서 붙여넣기만 하지 말고, 일부 내용을 발췌해서 저장해 두면 다시 입력할 필요가 없습니다.