You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
3.0 KiB
3.0 KiB
코드를 주석 처리하세요
지침
깔끔하고 잘 문서화된 코드는 프로젝트를 유지 관리하고 공유하는 데 필수적입니다. 이번 과제에서는 전문 개발자가 지녀야 할 가장 중요한 습관 중 하나인, 코드의 목적과 기능을 설명하는 명확하고 유용한 주석을 작성하는 연습을 합니다.
게임 폴더 내 현재 app.js 파일을 살펴보고, 주석을 달고 정리하는 방법을 찾아보세요. 코드는 쉽게 통제 불능 상태가 될 수 있으므로, 나중에 사용할 수 있도록 읽기 쉬운 코드를 위해 주석을 추가하는 좋은 기회입니다.
과제 내용:
- 코드의 각 주요 부분이 하는 일을 설명하는 주석 추가
- 함수의 목적과 매개변수를 명확하게 설명하는 함수 문서화
- 코드를 논리적인 블록으로 나누고 섹션 헤더로 정리
- 사용하지 않거나 중복된 코드를 제거
- 변수와 함수에 대해 일관된 명명 규칙 사용
평가 기준
| 기준 | 우수 | 적절 | 개선 필요 |
|---|---|---|---|
| 코드 문서화 | app.js 코드가 모든 주요 섹션과 함수에 대해 명확하고 유용한 설명으로 완전히 주석 처리됨 |
app.js 코드가 대부분의 섹션에 대해 기본적인 설명으로 적절하게 주석 처리됨 |
app.js 코드에 주석이 거의 없고 명확한 설명이 부족함 |
| 코드 조직 | 코드가 논리적인 블록으로 구분되고 명확한 섹션 헤더 및 일관된 구조를 가짐 | 코드가 일부 관련 기능을 기본적으로 그룹화하여 어느 정도 조직됨 | 코드가 다소 산만하고 따라가기 어려움 |
| 코드 품질 | 모든 변수와 함수가 설명적인 이름을 사용하고, 사용하지 않는 코드가 없으며 일관된 규칙을 따름 | 대부분의 코드가 좋은 명명 관행을 따르고 사용하지 않는 코드가 최소화됨 | 변수 이름이 불명확하고, 사용하지 않는 코드가 포함되며 스타일이 일관되지 않음 |
면책 조항:
이 문서는 AI 번역 서비스 Co-op Translator를 사용하여 번역되었습니다. 정확성을 위해 최선을 다하고 있으나, 자동 번역은 오류나 부정확성이 포함될 수 있음을 유의하시기 바랍니다. 원본 문서가 권위 있는 출처로 간주되어야 합니다. 중요한 정보의 경우, 전문가의 인간 번역을 권장합니다. 이 번역 사용으로 인한 오해나 잘못된 해석에 대해서 당사는 책임을 지지 않습니다.