Visual Studio Snippet 활용

[SAgiKPJH]

코드 조각 계획

• 예시로 "UpdateDatasetRunningStatusQuery"를 입력하고
• "MediatR"이라는 키워드를 입력하면 자동으로 아래를 작성해주는 코드 조각

public record UpdateDatasetRunningStatusQueryRequest() : IRequest<Option<UpdateDatasetRunningStatusQueryResponse>>;
public record UpdateDatasetRunningStatusQueryResponse();
public class UpdateDatasetRunningStatusQueryHanlder : IRequestHandler<UpdateDatasetRunningStatusQueryRequest, Option<UpdateDatasetRunningStatusQueryResponse>>
{
    public async Task<Option<UpdateDatasetRunningStatusQueryResponse>> Handle(UpdateDatasetRunningStatusQueryRequest request, CancellationToken cancellationToken)
    {
        await Task.CompletedTask;
        throw new NotImplementedException();
    }
}

코드 조각 생성

• 새 파일 > XML
  • 
• 값 기입 후 *.snippet 파일로 저장
  • 

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet>
    <Header>
      <Title>UpdateDatasetRunningStatusQuery</Title>
      <Shortcut>MediatR</Shortcut>
      <Description>Creates a MediatR query and handler for updating dataset running status.</Description>
      <Author>SagiKPJH</Author>
    </Header>
    <Snippet>
      <Declarations>
        <Literal>
          <ID>QueryName</ID>
          <ToolTip>Name of the query</ToolTip>
          <Default>TestQuery</Default>
        </Literal>
      </Declarations>
      <Code Language="csharp">
        <![CDATA[
<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet>
    <Header>
      <Title>UpdateDatasetRunningStatusQuery</Title>
      <Shortcut>mediatrrequest</Shortcut>
      <Description>Creates a MediatR query and handler for updating dataset running status.</Description>
      <Author>SagiKPJH</Author>
    </Header>
    <Snippet>
      <Declarations>
        <Literal>
          <ID>QueryName</ID>
          <ToolTip>Name of the query</ToolTip>
          <Default>TestQuery</Default>
        </Literal>
      </Declarations>
      <Code Language="csharp">
        <![CDATA[
public record $QueryName$Request() : IRequest<Option<$QueryName$Response>>;
public record $QueryName$Response();
public class $QueryName$Handler : IRequestHandler<$QueryName$Request, Option<$QueryName$Response>>
{
    public async Task<Option<$QueryName$Response>> Handle($QueryName$Request request, CancellationToken cancellationToken)
    {
        await Task.CompletedTask;
        throw new NotImplementedException();
    }
}
        ]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

• 도구 > 코드조각 관리자 > 폴더 지정
  • 

사용

• IntelliSense 자동 완성 기능 활성화
  • 
• 사용
  • https://github.com/user-attachments/assets/63b77371-e989-4878-ba47-e737c8f1c6dd
  • https://github.com/user-attachments/assets/d4db9e2d-aacc-482c-92f1-74f8888f6c22

[SAgiKPJH]

• 참조
  • https://learn.microsoft.com/ko-kr/visualstudio/ide/walkthrough-creating-a-code-snippet?view=vs-2022
  • https://youngchulshin.tistory.com/12