좋은 주석
1.품질나쁜 코드는 주석말고 코드를 고쳐라
int d; // 날짜 저장
d = 3; // 3일
// ... 코드 내에 d 변수 사용
int dayOfMonth = 3; // 3일
2.주석보단 코드로 보기좋게 만들어라
// 임시 변수를 사용하여 총 가격 계산
double a = price * quantity;
double b = a * taxRate;
double c = b - discount;
double totalPrice = price * quantity;
double totalTax = totalPrice * taxRate;
double finalPrice = totalTax - discount;
3.정보 제공을 하는 주석
/**
* 사용자 데이터를 데이터베이스에 저장한다.
*
* @param user 저장할 사용자 객체
*/
void saveUser(User user) {
// ... 코드
}
4.결과 경고를 하는 주석
// 이 메소드는 매우 오래 걸릴 수 있다.
void performComplexCalculation() {
// ... 복잡한 계산 코드
}
5.의도 설명을 하는 주석
// 이 값은 사용자에게 보여질 때만 사용됨
String displayName = "John Doe";
6.코드를명료하게밝히는 주석
// 'null'이 반환될 수 있는 상황을 처리
if (result == null) {
handleNullResult();
}
7.TODO 주석
// TODO: 이 메소드를 더 최적화할 방법을 찾기
void calculateTotal() {
// ... 코드
}
8.중요성을 강조하는 주석
// 중요: 이 배열은 0부터 시작하는 인덱스를 사용한다.
int[] values = new int[10];
9.코드 내용을 중복하는 주석을 쓰지마라
int age = 25; // 나이는 25
10.당연한 사실을 언급하는 주석을 쓰지마라
// 두 값을 더한다
int sum = a + b;
11.코드를 주석처리해 방치하지마라
// int oldVariable = 10;
