-
[Coding Convention] 주석, 예외처리프로그래밍 언어 2022. 4. 15. 14:36
1. 주석
- 모든 코드, 모든 변수에 주석을 달 필요 없음
- /* ... */ 대신에 //나 /// 을 사용
- 숫자 값을 특정한 값으로 초기화 하게 되는 경우 문서에 그 값으로 초기화하는 이유를 충분히 작성
- 메소드의 Summary 를 작성
2. 예외처리
- 아무 처리도 하지 않는 캐치를 작성하지 않음. 이는 추후에 예상한 결과든 예상하지 못한 결과든 모두 잡아낼 수 없게 됨. 항상 예외가 발생하지 않도록 트라이 블록에서 처리하고, 캐치블록에서는 반드시 예외에 대한 처리를 하라. (최악의 경우 이러한 코딩을 하고 싶다면 로그를 남기고 진행)
- 예외 발생 시 사용자에게는 간결하고 친절한 메세지를 보여주되 내부적으로 시간, 메소드, 인자, 클래스명 등을 로그로 남김
- 긴 코드의 트라이 캐치를 작성하지 않음. 필요하다면 코드의 조각을 구분하고 각각의 조각에 처리를 해줌. (이는 어떤 오류가 발생했는지 찾기도 쉽고, 사용자에게 메세지를 보여주기도 수월함)
'프로그래밍 언어' 카테고리의 다른 글
[Coding Convention] 프로그래밍 습관 (0) 2022.04.15 [Coding Convention] 들여쓰기, 공백 (0) 2022.04.15 [Coding Convention] 명명 규칙과 표준 (0) 2022.04.15 [Coding Convention] 파스칼 케이싱, 캐멀 케이싱 (0) 2022.04.15