코드 설명

watsonx Code Assistant

생성형 AI를 사용하여 코드를 분석하고 요약하여 코드의 기능을 파악하세요.

다음 표에는 각 요금제에 대한 설명 유형이 나와 있습니다.

설명 유형
계획 설명 설명
평가판 요금제 에센셜 요금제 기본 생성형 AI를 사용하여 기본적인 설명을 제공합니다. 별도의 코드 분석이 필요하지 않습니다.
Standard 플랜 개선됨 빌드된 애플리케이션이 필요하며 코드 분석 및 생성 AI를 사용하여 Java 메서드/클래스 및 엔터프라이즈 Java 애플리케이션에 대한 향상된 코드 설명을 제공합니다.

Eclipse IDE 전용: 멀티 모듈 Java 최적으로 활용하려면, 어그리게이터 모듈과 각 서브 모듈을 Eclipse 내에서 별도의 프로젝트로 가져오십시오. 최상위 디렉토리를 단일 프로젝트로 가져오면 Watsonx Code Assistant 프로젝트를 성공적으로 인트로스펙트할 가능성이 낮습니다.

언어 지원

다음 언어에 대한 코드 설명이 제공됩니다:

  • C
  • C++
  • Go
  • Java
  • JavaScript
  • Python
  • TypeScript

메서드를 참조하거나 메서드에서 CodeLens 을 사용하는 경우 watsonx Code Assistant 은 특정 코드 언어를 지원합니다. 전체 파일을 참조하는 것은 모든 언어에서 작동합니다. 자세한 내용은 메서드로 작업할 때 언어 지원을 참조하세요.

채팅 명령을 사용하여 코드 설명하기

채팅에서 ' /explain ' 명령을 사용하여 활성 워크스페이스에서 참조된 클래스, 파일, 함수 또는 메서드에 대한 코드를 설명할 수 있습니다.

다음 구문을 사용하십시오.

/explain <code reference> [additional instructions]

  • 프롬프트는 /explain 로 시작하고 나머지 구문을 입력해야 합니다.

  • ' <code reference>'의 경우 ' @ ' 기호를 입력하면 작업 영역의 클래스, 파일, 함수 및 메서드 목록을 볼 수 있습니다. 한 번에 하나의 클래스, 파일, 함수 또는 메서드 참조를 사용합니다.

  • ' [additional instructions] '은 선택 사항입니다. 구체적인 세부 정보가 필요한 경우 지침을 추가합니다.

파일을 참조할 때 크기 제한은 50KB입니다. 이 제한에 도달하면 파일을 개별 함수로 분할하고 각 함수를 참조하세요. 또는 49KB로 파일을 분할하여 함수 경계를 관리하고 분할할 때마다 파일을 참조하세요. 어느 방법을 사용하든 결과를 병합해야 합니다.

에디터에서 CodeLens 사용하여 코드 설명하기

IDE 에디터에서 CodeLens 코드 블록과 스니펫 앞에 생성 AI 옵션 줄을 표시합니다.

알려진 문제 watsonx Code Assistant for Enterprise Java Applications 확장자를 사용하는 경우, 시작 시 CodeLens 향상된 Java 기능을 사용할 수 있는 데 몇 초가 걸릴 수 있습니다.

  1. 코드 블록 바로 앞에 있는 설명 옵션을 클릭하여 설명을 생성합니다.

    다음 코드 예시에서는 ' Explain | Document | Unit Test ' 옵션이 ' protected void ' 키워드 바로 앞에 있습니다.

    코드 렌즈 예제
    CodeLens 예제

  2. watsonx Code Assistant 채팅 창이 열리고 ' /explain @<*item name*> ' 명령이 표시되며 명령이 실행되고 설명이 표시됩니다.

비활성화 CodeLens

CodeLens 옵션을 사용하지 않으려면 확장 프로그램 또는 플러그인의 설정을 변경하면 됩니다.

Visual Studio Code 에서 :

  1. 확장 프로그램의 설정을 엽니다.

  2. Enable CodeLens 설정을 지웁니다.

Eclipse 에서 :

  1. Eclipse IDE 에 대한 설정을 엽니다.

  2. watsonx Code Assistant 설정 항목에서 Enable CodeLens 설정을 지웁니다.

  3. 적용을 클릭하고 닫습니다.

탐색기를 사용하여 코드 설명하기

탐색기( Visual Studio Code ) 또는 프로젝트 탐색기( Eclipse )에서 설명을 생성하려면 다음과 같이 하세요:

  1. 설명을 생성하려는 코드로 애플리케이션을 확장합니다.

  2. 코드를 마우스 오른쪽 버튼으로 클릭하고 watsonx Code Assistant 클릭한 다음 설명을 클릭합니다.

  3. watsonx Code Assistant 채팅에 선택한 코드에 대한 ' /explain ' 명령이 표시됩니다. 이 명령에는 다음 구문이 사용됩니다:

    /explain <code syntax>

  4. {{{site.data.keyword.wca_short_cap}} 요청을 처리하고 채팅에 선택한 코드에 대한 설명을 표시합니다.

Java 애플리케이션 설명하기

표준 요금제 애플리케이션 설명은 watsonx Code Assistant for Enterprise Java Applications 확장자만 사용할 수 있습니다.

애플리케이션 설명은 ' javax.servlet.http.HttpServlet'을 확장하는 클래스를 하나 이상 포함하는 Java 애플리케이션에 대해서만 지원됩니다. 이러한 클래스는 ' doGet, ' doPost' , ' doPut' 중 하나의 메서드를 구현해야 합니다.

대규모 애플리케이션의 경우 순환 복잡도가 가장 높은 40개의 엔트리 포인트를 고려한 설명입니다. 신청서가 40개 항목 점수를 초과하는 경우, 설명에 어떤 항목 점수를 고려하지 않았는지 자세히 설명하는 섹션( The following methods were not considered: )이 포함되어 있습니다.

신청서에 대한 설명을 요청하고 확인하려면 다음과 같이 하세요:

  1. IDE에서 설명하려는 애플리케이션 디렉터리의 계층 구조에 있는 항목을 마우스 오른쪽 버튼으로 클릭한 다음 애플리케이션 설명을 클릭합니다.

    Eclipse IDE 피어 멀티모듈 루트가 있는 멀티모듈 애플리케이션이 있는 경우 애플리케이션 설명은 선택한 모듈에만 적용됩니다.

  2. {{{site.data.keyword.wca_short_cap}} 애플리케이션을 스캔하여 각 방법에 대한 기능 설명과 함께 개요 및 주요 서비스 목록을 생성합니다.

  3. 저장을 클릭하여 사본을 유지하거나 설명이 삭제됩니다.

  4. 설명 열기 및 검토를 클릭한 다음 애플리케이션 설명 저장을 클릭하여 로컬 파일에 저장할 수 있습니다.