글쓰기

내 코드에 생명을 불어넣는 주석 자동 생성기!

이 프롬프트는 소스 코드에 체계적인 주석을 자동으로 추가하여, 코드의 가독성, 유지보수성, 이해도를 획기적으로 높여줍니다.

프롬프트 코드

system_prompt.txt
전문 소프트웨어 개발자가 되어 다음 코드에 주석을 달아주세요. 핵심 목표는 명확하고 간결하며 유익한 주석을 체계적인 형식으로 제공하여 코드의 가독성과 유지보수성을 극대화하는 것입니다. 이를 위해 코드 구조를 분석하고, 핵심 구성 요소와 기능을 파악하며, 복잡한 논리나 알고리즘을 설명해야 합니다. 코드의 기능뿐만 아니라 특정 결정의 배경, 발생 가능한 예외 상황, 그리고 향후 개발자를 위한 핵심 고려 사항까지 상세히 설명하는 주석을 작성해야 합니다.

단계별로 신중하게 접근하여 문제를 해결하세요.

# 요청 정보:
코드: [주석을 달 코드 또는 첨부된 문서 참조]
프로그래밍 언어: [사용된 프로그래밍 언어]
코드 복잡도 수준: [초급, 중급, 고급 중 택 1]
주요 주석 집중 분야: [설명에 집중하고 싶은 특정 영역]
코드 목적/기능: [코드의 목적 또는 기능]
대상 독자: [초보 개발자, 팀원, 오픈 소스 기여자 등]

출력 시, 코드 조각과 인라인 주석은 물론, 주요 섹션이나 함수에 대한 별도의 블록 주석을 조합하여 제공해야 합니다. 반드시 지정된 프로그래밍 언어에 적합한 주석 구문을 사용하세요.

결과물 예시

gemini.google.com
GeminiGemini

왜 실무에서먹힐까?

  • 코드 가독성과 유지보수성을 극대화하는 체계적인 주석을 자동으로 생성합니다.
  • 복잡한 논리와 알고리즘을 명확하게 설명하여, 어떤 코드든 빠르게 이해할 수 있도록 돕습니다.
  • 코드 결정 배경, 잠재적 예외, 미래 개발 방향까지 통찰력 있는 정보를 제공합니다.

실전 노하우

  • 복잡한 알고리즘이나 독창적인 로직 등 상세한 설명이 필요한 핵심 코드 영역을 명확히 명시하여, 향후 개발자의 이해를 돕습니다.
  • 일관되고 명확한 주석 형식을 사용해 코드 가독성을 유지하고, 개발 과정의 흐름을 쉽게 파악할 수 있도록 만드세요.
  • 코드 변경 사항에 맞춰 주석을 주기적으로 업데이트하여, 항상 최신의 정확한 정보를 유지하도록 관리하세요.

일잘러가쓰는 방법

  • 다음 지시문에 맞춰 코딩 환경과 목표에 대한 구체적인 정보를 입력하세요.
  • 코드: [주석을 달 코드 또는 첨부된 문서 참조]
  • 프로그래밍 언어: [사용된 프로그래밍 언어]
  • 코드 복잡도 수준: [초급, 중급, 고급 중 택 1]
  • 주요 주석 집중 분야: [설명에 집중하고 싶은 특정 영역]
  • 코드 목적/기능: [코드의 목적 또는 기능]
  • 대상 독자: [초보 개발자, 팀원, 오픈 소스 기여자 등] 예시: "코드: 첨부된 문서 참조. 프로그래밍 언어: Python. 코드 복잡도 수준: 중급. 주요 주석 집중 분야: 알고리즘 효율성 및 오류 처리. 코드 목적/기능: 데이터 처리 및 분석. 대상 독자: 초급 개발자 및 팀원."
내 코드에 생명을 불어넣는 주석 자동 생성기! | 글쓰기 Gemini 프롬프트 | 프롬프트 포레스트