GitHub Copilot "설명" 및 "문서" 기능 검토

  • 5분

GitHub Copilot 사용하면 개발자가 복잡하거나 익숙하지 않은 코드를 더 쉽게 사용할 수 있습니다. Visual Studio Code 개발자는 코드를 분석, 설명 또는 문서화하는 GitHub Copilot 기능에 직접 액세스할 수 있습니다.

GitHub Copilot 사용하여 코드 분석 및 설명

다음 GitHub Copilot 기능을 사용하여 코드를 분석하고 설명할 수 있습니다.

  • 질문 모드: 요청 모드의 채팅 보기를 사용하여 전체 작업 영역을 분석하고 코딩 항목, 기술 개념 및 일반적인 프로그래밍 방법에 대해 질문합니다.

  • 인라인 채팅: 편집기에서 직접 인라인 채팅 세션을 시작하여 특정 코드 섹션에 대해 묻습니다.

  • 스마트 작업: 스마트 작업 설명을 실행하여 프롬프트를 작성할 필요 없이 선택한 코드를 설명합니다.

  • 빠른 채팅: 빠른 질문을 하고 현재 작업을 다시 시작하세요.

GitHub Copilot 사용하여 인라인 코드 설명서 생성

다음 GitHub Copilot 기능을 사용하여 인라인 코드 설명서를 생성할 수 있습니다.

  • 요청 모드: Ask 에이전트 모드를 사용하여 코드 파일, 클래스 또는 메서드에 대한 인라인 코드 설명서를 제안합니다. 채팅 보기에서 제안된 인라인 설명서를 검토합니다. 채팅 대화에서 필요에 따라 업데이트를 요청합니다. 제안된 설명서에 만족하면 제안된 설명서를 해당 코드 파일에 삽입할 수 있습니다.

  • 계획 모드: 계획 모드를 사용하여 설명서 작업에 대한 자세한 구현 계획을 만듭니다. 계획 모드를 사용하여 코드베이스를 분석하고, 설명서 요구 사항을 식별하고, 단계별 계획을 생성할 수 있습니다. 계획이 승인되면 실행을 위해 에이전트 모드로 넘겨줄 수 있습니다.

  • 에이전트 모드: 에이전트 모드를 사용하여 지정된 코드 프로젝트, 파일, 클래스 또는 메서드에 대한 인라인 코드 설명서를 자율적으로 생성합니다. 에이전트가 설명서 프로세스 도중 또는 이후에 다른 작업을 수행하게 합니다. 에이전트가 할당된 작업을 완료한 경우 업데이트를 수락하거나 거부합니다.

  • 인라인 채팅 - 인라인 채팅 세션을 사용하여 코드 편집기에서 직접 작업합니다. 인라인 채팅은 편집기를 종료하지 않고 특정 코드(클래스, 메서드 또는 코드 블록)를 문서화하려는 경우에 유용합니다. 프롬프트에 특정 지침을 제공하거나 원하는 경우 특정 정보 없이 슬래시 명령을 사용할 /doc 수 있습니다. 업데이트는 코드 편집기에서 표시되며 수락되거나 거부될 수 있습니다. 업데이트 여부에 관계없이 프롬프트를 다시 실행할 수 있는 옵션을 선택할 수도 있습니다.

  • Docs 스마트 작업 생성: Docs 스마트 작업 생성을 사용하여 선택한 클래스, 메서드 또는 코드 블록에 대한 인라인 코드 설명서를 생성합니다. 문서 생성 스마트 작업은 프롬프트가 필요한 특정 요구 사항이 없는 경우에 유용합니다. 업데이트는 코드 편집기에서 표시되며 수락되거나 거부될 수 있습니다. 스마트 작업을 다시 실행할 수도 있습니다.

GitHub Copilot 사용하여 프로젝트 설명서 생성

다음 GitHub Copilot 기능을 사용하여 프로젝트 설명서를 생성할 수 있습니다.

  • Ask 에이전트 모드의 채팅 보기: Ask 에이전트를 사용하여 코드베이스를 분석하고 코드 프로젝트, 파일 및 클래스를 이해합니다. Ask 에이전트를 사용하여 제안된 프로젝트 설명서를 미리 볼 수 있습니다. 필요에 따라 제안을 검토하고 업데이트 또는 기타 세부 정보를 요청합니다. 제안된 설명서를 프로젝트 설명서 파일(README.md)에 삽입합니다.

  • 계획 에이전트 모드의 채팅 보기: 프로젝트 설명서에 대한 자세한 구현 계획을 만든 다음 실행을 위해 에이전트 모드로 전달합니다.

  • 에이전트 모드의 채팅 보기: 프로젝트 설명서 파일 모음 생성: README.md 만들기/업데이트, UsageExamples.md 만들기/업데이트, ChangeLog.md 만들기/업데이트 문서 파일, 상호 참조 클래스 및 메서드 간의 링크를 포함하고 문서 간에 일관성을 보장합니다.

중요합니다

에이전트 모드에서 채팅 보기를 통해 입력하는 각 프롬프트는 모델의 승수에 따라 곱해지는 하나의 프리미엄 요청으로 계산됩니다. GitHub Copilot 작업을 완료하기 위해 몇 가지 후속 작업을 수행할 수 있지만 이러한 후속 작업은 프리미엄 요청 사용량에 포함되지 않습니다. 입력한 프롬프트만 요금이 청구됩니다. 사용되는 총 프리미엄 요청은 입력한 프롬프트 수와 선택한 모델에 따라 달라집니다. GitHub Copilot 무료 플랜은 매월 50개의 프리미엄 요청을 받습니다. 각 GitHub Copilot 구독에 대한 프리미엄 요청 제한에 대한 자세한 내용은 계획 설명을 확인하세요.

요약

GitHub Copilot 코드를 빠르고 정확하게 분석하고 문서화하는 데 도움이 됩니다. 채팅 보기, 인라인 채팅, 빠른 채팅 및 스마트 작업 기능은 Visual Studio Code 환경 내에서 직접 다양한 수준의 상호 작용을 제공합니다.