코드 문서화

watsonx Code Assistant

코드가 수행하는 작업을 문서화하는 주석 줄을 생성합니다.

언어 지원 및 표준

다음 표에는 코드 언어와 각 코드 언어에 해당하는 문서 표준이 나와 있습니다.

문서 표준
코드 문서 표준
C 산소
C++ 산소
Go GoDoc
Java JavaDoc
JavaScript jsdoc
TypeScript jsdoc
기타 모두 Markdown

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

채팅 명령을 사용하여 문서 생성하기

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

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

/document <code reference> [additional instructions]

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

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

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

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

에디터에서 CodeLens 사용하여 문서 생성하기

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

  1. 코드 블록 또는 스니펫 바로 앞에 있는 문서 옵션을 클릭하여 해당 문서를 생성합니다.

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

    코드 렌즈 예제
    CodeLens 예제

  2. watsonx Code Assistant 채팅 창이 열리고 ' /document @<*item name*> ' 명령이 표시되며, 해당 명령이 실행되고 설명서가 주석으로 추가된 코드가 표시됩니다.

비활성화 CodeLens

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

Visual Studio Code 에서 :

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

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

Eclipse 에서 :

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

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

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