코드의 결정을 설명하는 주석 작성 방법.
주석은 의도나 명확하지 않은 제약을 설명해야 합니다. 단순한 코드 한 줄을 문장으로 반복하면 잡음이 됩니다.
작업에 맞게 절차를 조정하세요.
코드 뒤에 있는 명확하지 않은 이유, 불변 조건, 제약을 찾아 관련 연산 가까이에 설명하세요. 쉬운 문법을 서술하기만 하는 주석은 제거하고 실제 동작과 설명을 일치시키세요.
- 제공할 내용
- 코드와 프로젝트 문서 스타일.
- 받을 결과
- 의도와 제약을 설명하는 유용한 주석.
입력과 결과를 확인하세요.
설명용 입력과 출력 · 실제 WebAct 실행이 아닌 학습용 예시
입력 항목 예시개
Add an intent comment to this JavaScript mapping. Original row IDs must remain available so reviewers can trace comparison results to their sources.
const copied = rows.map(row => ({ ...row }));완성된 예시
// Retain source row IDs so reviewers can trace each comparison finding.
const copied = rows.map(row => ({ ...row }));
The comment explains why the IDs remain. The code still makes shallow copies; nested objects are shared.이 입력을 프롬프트에 넣고 WebAct에 복사해 작업을 실행해 보세요. 결과는 설명용 예시와 다를 수 있습니다.
판단 기준과 문제 해결.
모든 대입문에 주석을 달아야 하나요?
의도나 제약이 불분명해질 곳에 주석을 다세요. 코드를 문장으로 반복하면 결정을 설명하지 못한 채 유지보수 일만 늘어납니다.
유용한 주석이 리팩터링 후 오해를 낳는 이유는 무엇인가요?
변경된 동작과 함께 검토하고 오래된 가정을 갱신하거나 제거하세요. 주석도 유지관리할 설명의 일부입니다.
직접 준비한 자료로 시도하세요.
작업 프롬프트의 예시를 내 자료로 바꾸세요. 필요한 요구 사항은 유지하고 작업을 WebAct에 복사하세요.
작업 맞춤 설정 및 복사 ↑