보이 스카웃 규칙(The Boy Scout rule)
보이 스카웃 규칙은 '떠날 때는 뒷정리를 반듯이 깨끗이 해야 한다.'라는 규칙이 있다.
반응형
< 보이 스카웃 규칙을 코드의 품질과 유지보수에 적용 >
| 설명 | |
| 코드 주석과 문서화 | 주석을 추가해서 코드의 의도를 명확히 설명해서 다른 개발자들의 실수 및 의도하지 않은 경우를 감소한다. |
| 효율적인 자원 사용 | 내장 기능을 활용해서 코드를 간결하고 효율적으로 작성한다. |
| 에러 처리 | 적절한 예외 처리를 통해 예상치 못한 상황에 대비하는것이 중요하다. |
| 코드 리뷰와 협업 | 읽기 쉬운 코드는 협업과 코드 리뷰를 향상 시킨다. |
< 코드 주석과 문서화 >
// 좋은 예시: 코드에 설명적인 주석 추가
public double CalculateArea(double radius)
{
// 원의 넓이를 계산합니다.
return 3.14 * Math.Pow(radius, 2);
}
< 효율적인 자원 사용 >
// 좋은 예시: 메모리를 효율적으로 사용하는 LINQ 쿼리
List<int> squares = Enumerable.Range(0, 10).Select(x => x * x).ToList();< 예외 처리>
// 좋은 예시: 적절한 에러 처리를 포함한 코드
try
{
double result = DivideNumbers(10, 0);
}
catch (DivideByZeroException ex)
{
Console.WriteLine($"에러 발생: {ex.Message}");
double result = 0; // 또는 다른 적절한 처리
}
< 코드 리뷰와 협업 >
// 좋은 예시: 적절한 에러 처리를 포함한 코드
try
{
double result = DivideNumbers(10, 0);
}
catch (DivideByZeroException ex)
{
Console.WriteLine($"에러 발생: {ex.Message}");
double result = 0; // 또는 다른 적절한 처리
}
캠핑 장소에서 쓰레기를 발견하면 반드시 치우고 가라는 말로 개발자들에게 적용하면
자신이 작업하는 코드 중 이상한 것을 발견하는 즉시 클린 코드로 수정하는 형태로 표현할 수 있다.
눈에 보이는 문제를 해결하지 않고 넘어간다면 언젠가는 그로 인한 사이드 이펙트나 버그가 생기기 마련이다.
★★☆☆☆
반응형
댓글