코드 자체로 설명이 충분한 경우에는 코드 주석을 작성할 필요가 없다. 불필요한 주석은 오히려 코드의 가독성을 해칠 수 있다. 주석을 위한 주석은 작성하지 마라. 주석이 꼭 필요할 때만 현명하게 사용하라.
다음 예제를 살펴보자. 코드 주석을 너무 많이 달면 다음처럼 보일 수 있다.
코드 3-16 모든 곳에 코드 주석을!
/// <summary>
/// 발송 주소 모델을 받아 데이터베이스에 그것을 업데이트한 다음,
/// 만약 문제가 없다면 사용자를 청구 페이지로 리디렉션한다. → 함수의 문맥과 선언이 이미 이것들을 설명하고 있다.
/// </summary>
/// <param name="form">받을 모델</param> /// <returns>오류가 있을 경우 주소를 입력하는 폼으로 /// 다시 연결하고, 성공할 경우 청구서 양식 페이지로 /// 재연결한다.</returns> [HttpPost] public IActionResult Submit(ShipmentAddress form) {
→ 함수의 문맥과 선언이 이미 이것들을 설명하고 있다.
// 쿠키를 저장하고 배송 정보를 입력하는 양식으로
// 재접속하는 공용 오류 처리 코드
IActionResult error() {
Response.Cookies.Append("shipping_error", "1");
return RedirectToAction("Index", "ShippingForm", form);
→ 문자 그대로 다음에 오는 코드를 반복하고 있다.
}