효과적인 개발 문서화를 위한 주석 및 설명글 작성법

#개발문서화 #문서화 #주석 #설명글

Use Case 설명

아래 프롬프트는 코드에 대한 주석 혹은 설명글 작성 시, 이해하기 쉽고 효과적인 내용을 만드는 데 도움을 줍니다. 코드의 이해를 돕기 위해 또는 후에 코드를 보게 될 동료 혹은 본인을 위해 적절한 주석을 달아두는 것이 중요합니다. GPT를 활용하여 주석 작성에 있어서 논리적이고 이해하기 쉬운 내용을 생성해보세요.

프롬프트 템플릿

⌨️ 
[코드 설명 혹은 코드 전문]

위 코드에 대해 이해하기 쉽고 효과적인 주석을 [한국어]로 작성해 줘.

프롬프트 결과 예시

주의 및 참고 사항

• GPT가 제공하는 내용을 그대로 사용하기보다는, 필요한 부분을 추가하거나 삭제하여 적절한 주석을 만들어야 합니다.
  

• 코드 전문만으로 의미를 유추하기 어려운 함수/변수 네이밍이 있다면 프롬프트에 추가로 설명해주세요.
  

• 주석이 얼마나 상세한 설명일지, 어떤 기반 지식까지 이야기할지에 대해 기대하는 수준이 있다면 프롬프트에 추가로 설명해주세요.