코드 리뷰
코멘트를 작성하기 전에 전체 diff를 읽으십시오. 먼저 버그를 나열하고, 그다음 위험, 마지막으로 가독성 문제를 나열하십시오. 각 코멘트를 짧게 유지하고 왜 중요한지 설명하십시오.
오류 처리
diff가 오류 처리를 변경할 때, 이후에 결과를 표시하십시오. 그런 다음 오류 처리를 유지하고, 발견한 내용에 대해 한 줄을 작성하십시오. diff가 오류 처리를 건드리는 각 위치를 기록하십시오. 지금 간단히 확인하면 나중에 긴 수정을 방지할 수 있습니다.
단계:
- diff가 오류 처리를 건드리는 각 위치를 세십시오. 매번 동일한 결과를 유지합니다.
- 변경 사항이 오류 처리를 변경할 때, 완료하기 전에 결과를 기록하십시오.
- 모듈이 오류 처리를 변경할 때, 이후에 결과를 나열하십시오.
- 모듈이 오류 처리를 건드리는 각 위치를 세십시오. 이것이 사람들이 가장 자주 묻는 부분입니다.
- 변경 사항에 오류 처리에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오.
- diff에 오류 처리에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오.
- 오류 처리를 구체적으로 유지하십시오. 이는 독자에게 세부 사항을 고려했음을 보여줍니다.
- 변경 사항에 오류 처리에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오.
| 확인 사항 | 좋음 | 개선 필요 |
|---|---|---|
| 오류 처리가 올바름 | 예, 모든 위치에서 | 일부 위치에서만 |
| 오류 처리가 일관됨 | 예, 모든 위치에서 | 일부 위치에서만 |
| 오류 처리가 구체적임 | 예, 모든 위치에서 | 일부 위치에서만 |
| 오류 처리가 유용함 | 예, 모든 위치에서 | 일부 위치에서만 |
예시:
이전: diff에 구체적이지 않은 오류 처리가 있습니다.
이후: 모듈에 구체적인 오류 처리가 있습니다.
이벤트
먼저 이벤트를 정렬한 다음, 발견한 내용에 대해 한 줄을 작성하십시오. 이벤트를 유용하게 유지하십시오. 지금 간단히 확인하면 나중에 긴 수정을 방지할 수 있습니다. 먼저 이벤트를 센 다음, 발견한 내용에 대해 한 줄을 작성하십시오.
단계:
- 이벤트를 안전하게 유지하십시오. 이는 독자에게 세부 사항을 고려했음을 보여줍니다.
- 완료하기 전에 이벤트를 센 다음, 발견한 내용에 대해 한 줄을 작성하십시오.
- 함수에 이벤트에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오.
- 테스트가 이벤트를 건드리는 각 위치를 확인하십시오. 이것이 사람들이 가장 자주 묻는 부분입니다.
- 이벤트를 끝에 유지한 다음, 발견한 내용에 대해 한 줄을 작성하십시오.
- 이벤트를 명확하게 유지하십시오. 여기서 작은 문제가 나중에 큰 문제가 되는 경우가 많습니다.
- 함수에 이벤트에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오.
- 이벤트를 짧게 유지하십시오. 이러한 종류의 실수는 대부분 초기에 고치기 쉽습니다.
| 확인 사항 | 좋음 | 개선 필요 |
|---|---|---|
| 이벤트를 변경하기 쉬움 | 예, 모든 위치에서 | 일부 위치에서만 |
| 이벤트를 테스트하기 쉬움 | 예, 모든 위치에서 | 일부 위치에서만 |
| 이벤트를 테스트하기 쉬움 | 예, 모든 위치에서 | 일부 위치에서만 |
| 이벤트를 안전함 | 예, 모든 위치에서 | 일부 위치에서만 |
예시:
이전: 인터페이스에 올바르지 않은 이벤트가 있습니다.
이후: diff에 스캔하기 쉬운 이벤트가 있습니다.
금액 값
모듈이 금액 값을 변경할 때, 먼저 결과의 이름을 지정하십시오. 변경 사항이 금액 값을 건드리는 각 위치의 이름을 지정하십시오. 이는 다음에 읽는 사람의 시간을 절약합니다. diff가 금액 값을 변경할 때, 완료하기 전에 결과를 축약하십시오.
단계:
- 함수에서 금액 값을 분할하고, 각각이 구체적인지 확인하십시오.
- 모듈이 금액 값을 건드리는 각 위치를 분할하십시오. 이는 다음에 읽는 사람의 시간을 절약합니다.
- 금액 값을 안전하게 유지하십시오. 여기서 작은 문제가 나중에 큰 문제가 되는 경우가 많습니다.
- 변경 사항에 금액 값에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오.
- 금액 값을 올바르게 유지하십시오. 이는 독자에게 세부 사항을 고려했음을 보여줍니다.
- 테스트에서 금액 값을 유지하고, 각각이 완전한지 확인하십시오.
- 테스트에서 금액 값을 제거하고, 각각이 일관된지 확인하십시오.
- 먼저 금액 값을 축약한 다음, 발견한 내용에 대해 한 줄을 작성하십시오.
| 확인 사항 | 좋음 | 개선 필요 |
|---|---|---|
| 금액 값이 일관됨 | 예, 모든 위치에서 | 일부 위치에서만 |
| 금액 값이 일관됨 | 예, 모든 위치에서 | 일부 위치에서만 |
| 금액 값이 안전함 | 예, 모든 위치에서 | 일부 위치에서만 |
| 금액 값이 단순함 | 예, 모든 위치에서 | 일부 위치에서만 |
예시:
이전: 함수에 일관되지 않은 금액 값이 있습니다.
이후: 함수에 유용한 금액 값이 있습니다.
모의 객체
모듈에서 모의 객체를 유지하고, 각각이 스캔하기 쉬운지 확인하십시오. 모의 객체를 구체적으로 유지하십시오. 매번 동일한 결과를 유지합니다. 모듈에서 모의 객체를 이동하고, 각각이 스캔하기 쉬운지 확인하십시오.
단계:
- 모듈이 모의 객체를 변경할 때, 완료하기 전에 결과를 결합하십시오.
- 변경 사항이 모의 객체를 건드리는 각 위치를 추가하십시오. 매번 동일한 결과를 유지합니다.
- 모듈이 모의 객체를 건드리는 각 위치를 결합하십시오. 이는 다음에 읽는 사람의 시간을 절약합니다.
- 함수에서 모의 객체를 나열하고, 각각이 단순한지 확인하십시오.
- 변경 사항에 모의 객체에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오.
- 함수가 모의 객체를 건드리는 각 위치를 찾으십시오. 지금 간단히 확인하면 나중에 긴 수정을 방지할 수 있습니다.
- 모의 객체를 테스트하기 쉽게 유지하십시오. 이는 다음에 읽는 사람의 시간을 절약합니다.
- 변경 사항이 모의 객체를 변경할 때, 먼저 결과를 유지하십시오.
| 확인 사항 | 좋음 | 개선 필요 |
|---|---|---|
| 모의 객체가 명확함 | 예, 모든 위치에서 | 일부 위치에서만 |
| 모의 객체가 스캔하기 쉬움 | 예, 모든 위치에서 | 일부 위치에서만 |
| 모의 객체가 안전함 | 예, 모든 위치에서 | 일부 위치에서만 |
| 모의 객체가 짧음 | 예, 모든 위치에서 | 일부 위치에서만 |
예시:
이전: 테스트에 일관되지 않은 모의 객체가 있습니다.
이후: 변경 사항에 짧은 모의 객체가 있습니다.
로깅
변경 사항이 로깅을 건드리는 각 위치를 확인하십시오. 여기서 작은 문제가 나중에 큰 문제가 되는 경우가 많습니다. diff에 로깅에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오. diff에서 로깅을 나열하고, 각각이 짧은지 확인하십시오.
단계:
- 테스트에서 로깅을 다시 작성하고, 각각이 안전한지 확인하십시오.
- 테스트에 로깅에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오.
- 완료하기 전에 로깅을 센 다음, 발견한 내용에 대해 한 줄을 작성하십시오.
- 변경 사항이 로깅을 변경할 때, 다음에 결과를 결합하십시오.
- 로깅을 테스트하기 쉽게 유지하십시오. 이 부분이 불명확하면 독자가 멈춥니다.
- 함수가 로깅을 변경할 때, 다음에 결과를 다시 작성하십시오.
- 인터페이스가 로깅을 변경할 때, 그때 결과를 제거하십시오.
- 먼저 로깅을 축약한 다음, 발견한 내용에 대해 한 줄을 작성하십시오.
| 확인 사항 | 좋음 | 개선 필요 |
|---|---|---|
| 로깅을 테스트하기 쉬움 | 예, 모든 위치에서 | 일부 위치에서만 |
| 로깅이 일관됨 | 예, 모든 위치에서 | 일부 위치에서만 |
| 로깅이 스캔하기 쉬움 | 예, 모든 위치에서 | 일부 위치에서만 |
| 로깅이 유용함 | 예, 모든 위치에서 | 일부 위치에서만 |
예시:
이전: 인터페이스에 테스트하기 어려운 로깅이 있습니다.
이후: 모듈에 올바른 로깅이 있습니다.
주석
먼저 주석을 축약한 다음, 발견한 내용에 대해 한 줄을 작성하십시오. 주석을 유용하게 유지하십시오. 이 부분이 불명확하면 독자가 멈춥니다. 테스트에서 주석을 제거하고, 각각이 단순한지 확인하십시오.
단계:
- 함수에서 주석을 추가하고, 각각이 스캔하기 쉬운지 확인하십시오.
- diff에서 주석을 읽고, 각각이 안전한지 확인하십시오.
- diff에 주석에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오.
- diff에 주석에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오.
- 다음으로 주석의 이름을 지정한 다음, 발견한 내용에 대해 한 줄을 작성하십시오.
- 그런 다음 주석을 나열한 다음, 발견한 내용에 대해 한 줄을 작성하십시오.
- 그런 다음 주석을 표시한 다음, 발견한 내용에 대해 한 줄을 작성하십시오.
- 변경 사항에서 주석을 정렬하고, 각각이 구체적인지 확인하십시오.
| 확인 사항 | 좋음 | 개선 필요 |
|---|---|---|
| 주석이 안전함 | 예, 모든 위치에서 | 일부 위치에서만 |
| 주석이 올바름 | 예, 모든 위치에서 | 일부 위치에서만 |
| 주석을 테스트하기 쉬움 | 예, 모든 위치에서 | 일부 위치에서만 |
| 주석을 변경하기 쉬움 | 예, 모든 위치에서 | 일부 위치에서만 |
예시:
이전: diff에 변경하기 어려운 주석이 있습니다.
이후: 인터페이스에 일관된 주석이 있습니다.
파일 처리
파일 처리를 끝에 이름을 지정한 다음, 발견한 내용에 대해 한 줄을 작성하십시오. diff에서 파일 처리를 찾고, 각각이 일관된지 확인하십시오. 변경 사항이 파일 처리를 건드리는 각 위치를 추가하십시오. 이 부분이 불명확하면 독자가 멈춥니다.
단계:
- 파일 처리를 구체적으로 유지하십시오. 이는 독자에게 세부 사항을 고려했음을 보여줍니다.
- 모듈이 파일 처리를 건드리는 각 위치를 추가하십시오. 여기서 작은 문제가 나중에 큰 문제가 되는 경우가 많습니다.
- diff가 파일 처리를 변경할 때, 이후에 결과를 이동하십시오.
- 파일 처리를 일관되게 유지하십시오. 이것이 사람들이 가장 자주 묻는 부분입니다.
- 테스트에 파일 처리에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오.
- 함수가 파일 처리를 변경할 때, 그때 결과를 추가하십시오.
- 테스트가 파일 처리를 변경할 때, 다음에 결과를 기록하십시오.
- 인터페이스가 파일 처리를 변경할 때, 완료하기 전에 결과를 다시 작성하십시오.
| 확인 사항 | 좋음 | 개선 필요 |
|---|---|---|
| 파일 처리가 안전함 | 예, 모든 위치에서 | 일부 위치에서만 |
| 파일 처리가 명확함 | 예, 모든 위치에서 | 일부 위치에서만 |
| 파일 처리가 올바름 | 예, 모든 위치에서 | 일부 위치에서만 |
| 파일 처리가 올바름 | 예, 모든 위치에서 | 일부 위치에서만 |
예시:
이전: 변경 사항에 변경하기 어려운 파일 처리가 있습니다.
이후: 변경 사항에 구체적인 파일 처리가 있습니다.
API 계약
끝에 API 계약을 기록한 다음, 발견한 내용에 대해 한 줄을 작성하십시오. 끝에 API 계약을 비교한 다음, 발견한 내용에 대해 한 줄을 작성하십시오. 끝에 API 계약을 결합한 다음, 발견한 내용에 대해 한 줄을 작성하십시오.
단계:
- diff에 API 계약에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오.
- 모듈이 API 계약을 건드리는 각 위치를 표시하십시오. 이것이 없으면 두 사람이 다른 답을 얻습니다.
- 인터페이스에 API 계약에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오.
- API 계약을 유용하게 유지하십시오. 이 부분이 불명확하면 독자가 멈춥니다.
- 함수가 API 계약을 변경할 때, 이후에 결과를 그룹화하십시오.
- 인터페이스가 API 계약을 변경할 때, 끝에 결과를 비교하십시오.
- 변경 사항에서 API 계약을 확인하고, 각각이 안전한지 확인하십시오.
- 함수가 API 계약을 건드리는 각 위치를 비교하십시오. 이것이 사람들이 가장 자주 묻는 부분입니다.
| 확인 사항 | 좋음 | 개선 필요 |
|---|---|---|
| API 계약을 변경하기 쉬움 | 예, 모든 위치에서 | 일부 위치에서만 |
| API 계약이 일관됨 | 예, 모든 위치에서 | 일부 위치에서만 |
| API 계약이 안전함 | 예, 모든 위치에서 | 일부 위치에서만 |
| API 계약을 테스트하기 쉬움 | 예, 모든 위치에서 | 일부 위치에서만 |
예시:
이전: 테스트에 일관되지 않은 API 계약이 있습니다.
이후: 인터페이스에 올바른 API 계약이 있습니다.
날짜 및 시간대
테스트에서 날짜 및 시간대를 추가하고, 각각이 올바른지 확인하십시오. 모듈에서 날짜 및 시간대를 비교하고, 각각이 일관된지 확인하십시오. 변경 사항이 날짜 및 시간대를 건드리는 각 위치를 그룹화하십시오. 이 부분이 불명확하면 독자가 멈춥니다.
단계:
- 모듈에 날짜 및 시간대에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오.
- 날짜 및 시간대를 스캔하기 쉽게 유지하십시오. 이렇게 하면 다음 단계가 훨씬 빨라집니다.
- 다음으로 날짜 및 시간대를 비교한 다음, 발견한 내용에 대해 한 줄을 작성하십시오.
- 그런 다음 날짜 및 시간대를 정렬한 다음, 발견한 내용에 대해 한 줄을 작성하십시오.
- diff에서 날짜 및 시간대를 결합하고, 각각이 명확한지 확인하십시오.
- diff가 날짜 및 시간대를 변경할 때, 다음에 결과를 제거하십시오.
- 변경 사항이 날짜 및 시간대를 건드리는 각 위치를 추가하십시오. 이 부분이 불명확하면 독자가 멈춥니다.
- 모듈에서 날짜 및 시간대를 기록하고, 각각이 단순한지 확인하십시오.
| 확인 사항 | 좋음 | 개선 필요 |
|---|---|---|
| 날짜 및 시간대가 올바름 | 예, 모든 위치에서 | 일부 위치에서만 |
| 날짜 및 시간대가 구체적임 | 예, 모든 위치에서 | 일부 위치에서만 |
| 날짜 및 시간대가 명확함 | 예, 모든 위치에서 | 일부 위치에서만 |
| 날짜 및 시간대가 안전함 | 예, 모든 위치에서 | 일부 위치에서만 |
예시:
이전: 함수에 명확하지 않은 날짜 및 시간대가 있습니다.
이후: diff에 일관된 날짜 및 시간대가 있습니다.
Null 검사
Null 검사를 명확하게 유지하십시오. 이러한 종류의 실수는 대부분 초기에 고치기 쉽습니다. 함수가 Null 검사를 변경할 때, 먼저 결과를 찾으십시오. 변경 사항에 Null 검사에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오.
단계:
- Null 검사를 안전하게 유지하십시오. 이러한 종류의 실수는 대부분 초기에 고치기 쉽습니다.
- 인터페이스에서 Null 검사를 그룹화하고, 각각이 올바른지 확인하십시오.
- 인터페이스가 Null 검사를 건드리는 각 위치를 나열하십시오. 여기서 작은 문제가 나중에 큰 문제가 되는 경우가 많습니다.
- 인터페이스에 Null 검사에 대한 규칙이 두 개 이상 있으면 하나의 규칙을 선택하여 모든 곳에서 사용하십시오.
- Null 검사를 완전하게 유지하십시오. 이 부분이 불명확하면 독자가 멈춥니다.
- 함수에서 Null 검사를 표시하고, 각각이 유용한지 확인하십시오.
- 테스트가 Null 검사를 변경할 때, 끝에 결과를 다시 작성하십시오.
- 함수가 Null 검사를 건드리는 각 위치를 읽으십시오. 지금 간단히 확인하면 나중에 긴 수정을 방지할 수 있습니다.
| 확인 사항 | 좋음 | 개선 필요 |
|---|---|---|
| Null 검사를 변경하기 쉬움 | 예, 모든 위치에서 | 일부 위치에서만 |
| Null 검사가 명확함 | 예, 모든 위치에서 | 일부 위치에서만 |
| Null 검사가 구체적임 | 예, 모든 위치에서 | 일부 위치에서만 |
| Null 검사를 변경하기 쉬움 | 예, 모든 위치에서 | 일부 위치에서만 |
예시:
이전: 함수에 명확하지 않은 Null 검사가 있습니다.
이후: 모듈에 안전한 Null 검사가 있습니다.
테스트 범위
변경 사항이 테스트 범위를 건드리는 각 위치를 확인하십시오. 테스트 범위를 변경하기 쉽게 유지하십시오. 여기서 작은 문제가 나중에 큰 문제가 되는 경우가 많습니다. diff에서 테스트 범위를 읽고, 각각이 완전한지 확인하십시오.
단계:
- 테스트 범위를 명확하게 유지하십시오. 이는 독자에게 세부 사항을 고려했음을 보여줍니다.
- 함수가 테스트 범위를 건드리는 각 위치를 추가하십시오. 이는 다음에 읽는 사람의 시간을 절약합니다.
- 인터페이스가 테스트 범위를 변경할 때, 이후에 결과를 이동하십시오.
- 테스트 범위가 일관된지 확인하십시오. 이 부분이 불명확하면 독자가 멈춥니다.
- 먼저 테스트 범위를 축약한 다음, 발견한 내용에 대해 한 줄을 작성하십시오.
- 완료하기 전에 테스트 범위를 세고, 각각이 유용한지 확인하십시오.
- 모듈이 테스트 범위를 변경할 때, 먼저 결과를 표시하십시오.
- 함수에서 테스트 범위를 그룹화하고, 각각이 유용한지 확인하십시오.
| 확인 사항 | 좋음 | 개선 필요 |
|---|---|---|
| 테스트 범위가 완전함 | 예, 모든 위치에서 | 일부 위치에서만 |
| 테스트 범위를 변경하기 쉬움 | 예, 모든 위치에서 | 일부 위치에서만 |
| 테스트 범위가 명확함 | 예, 모든 위치에서 | 일부 위치에서만 |
| 테스트 범위가 안전함 | 예, 모든 위치에서 | 일부 위치에서만 |
예시:
이전: 함수에 완전하지 않은 테스트 범위가 있습니다.
이후: diff에 유용한 테스트 범위가 있습니다.
데이터 무결성
변경 사항이 데이터 무결성을 건드리는 각 위치를 추가하십시오. 이는 다음에 읽는 사람의 시간을 절약합니다. 데이터 무결성을 올바르게 유지하십시오. 이는 독자에게 세부 사항을 고려했음을 보여줍니다. 인터페이스에서 데이터 무결성을 표시하고, 각각이 유용한지 확인하십시오.
단계:
- 데이터 무결성을 명확하게 유지하십시오. 여기서 작은 문제가 나중에 큰 문제가 되는 경우가 많습니다.
- 변경 사항이 데이터 무결성을 건드리는 각 위치를 기록하십시오. 이것이 사람들이 가장 자주 묻는 부분입니다.
- 데이터 무결성을 안전하게 유지하십시오. 이러한 종류의 실수는 대부분 초기에 고치기 쉽습니다.
- 테스트가 데이터 무결성을 건드리는 각 위치를 그룹화하십시오. 지금 간단히 확인하면 나중에 긴 수정을 방지할 수 있습니다.
- 모듈이 데이터 무결성을 변경할 때, 끝에 결과를 비교하십시오.
- 함수가 데이터 무결성을 변경할 때, 다음에 결과를 결합하십시오.
- diff가 데이터 무결성을 변경할 때, 그때 결과를 다시 작성하십시오.
- 테스트가 데이터 무결성을 변경할 때, 이후에 결과를 그룹화하십시오.
| 확인 사항 | 좋음 | 개선 필요 |
|---|---|---|
| 데이터 무결성이 올바름 | 예, 모든 위치에서 | 일부 위치에서만 |
| 데이터 무결성이 구체적임 | 예, 모든 위치에서 | 일부 위치에서만 |
| 데이터 무결성이 명확함 | 예, 모든 위치에서 | 일부 위치에서만 |
| 데이터 무결성을 테스트하기 쉬움 | 예, 모든 위치에서 | 일부 위치에서만 |
예시:
이전: 모듈에 올바르지 않은 데이터 무결성이 있습니다.
이후: diff에 구체적인 데이터 무결성이 있습니다.
동시성
모듈에서 동시성을 정렬하고, 각각이 안전한지 확인하십시오. 동시성을 안전하게 유지하십시오. 이러한 종류의 실수는 대부분 초기에 고치기 쉽습니다. 먼저 동시성을 축약한 다음, 발견한 내용에 대해 한 줄을 작성하십시오.
단계:
- 동시성을 일관되게 유지하십시오. 이는 독자에게 세부 사항을 고려했음을 보여줍니다.
- 변경 사항이 동시성을 건드리는 각 위치를 찾으십시오. 이는 다음에 읽는 사람의 시간을 절약합니다.
- diff가 동시성을 변경할 때, 먼저 결과를 추가하십시오.
- 함수가 동시성을 건드리는 각 위치를 확인하십시오. 지금 간단히 확인하면 나중에 긴 수정을 방지할 수 있습니다.
- 인터페이스에서 동시성을 기록하고, 각각이 완전한지 확인하십시오.
- 변경 사항이 동시성을 건드리는 각 위치를 추가하십시오. 이러한 종류의 실수는 대부분 초기에 고치기 쉽습니다.
- 테스트가 동시성을 변경할 때, 다음에 결과를 표시하십시오.
- 계속되기 전에 동시성을 확인하고, 각각이 명확한지 확인하십시오.
| 확인 사항 | 좋음 | 개선 필요 |
|---|---|---|
| 동시성이 안전함 | 예, 모든 위치에서 | 일부 위치에서만 |
| 동시성이 올바름 | 예, 모든 위치에서 | 일부 위치에서만 |
| 동시성이 구체적임 | 예, 모든 위치에서 | 일부 위치에서만 |
| 동시성을 테스트하기 쉬움 | 예, 모든 위치에서 | 일부 위치에서만 |
예시:
이전: 함수에 안전하지 않은 동시성이 있습니다.
이후: 모듈에 안전한 동시성이 있습니다.
배포 구성
변경 사항이 배포 구성을 건드리는 각 위치를 기록하십시오. 이러한 종류의 실수는 대부분 초기에 고치기 쉽습니다. 배포 구성을 안전하게 유지하십시오. 이러한 종류의 실수는 대부분 초기에 고치기 쉽습니다. 배포 구성이 일관된지 확인하십시오. 이 부분이 불명확하면 독자가 멈춥니다.
단계:
- 배포 구성을 안전하게 유지하십시오. 이는 다음에 읽는 사람의 시간을 절약합니다.
- 모듈이 배포 구성을 건드리는 각 위치를 찾으십시오. 이것이 사람들이 가장 자주 묻는 부분입니다.
- 변경 사항이 배포 구성을 건드리는 각 위치를 추가하십시오. 이는 다음에 읽는 사람의 시간을 절약합니다.
- 인터페이스가 배포 구성을 변경할 때, 그때 결과를 표시하십시오.
- 완료하기 전에 배포 구성을 세고, 각각이 올바른지 확인하십시오.
- 함수가 배포 구성을 건드리는 각 위치를 추가하십시오. 이러한 종류의 실수는 대부분 초기에 고치기 쉽습니다.
- diff가 배포 구성을 변경할 때, 다음에 결과를 그룹화하십시오.
- 계속되기 전에 변경 사항에서 배포 구성을 확인하고, 각각이 안전한지 확인하십시오.
| 확인 사항 | 좋음 | 개선 필요 |
|---|---|---|
| 배포 구성이 안전함 | 예, 모든 위치에서 | 일부 위치에서만 |
| 배포 구성이 안전함 | 예, 모든 위치에서 | 일부 위치에서만 |
| 배포 구성이 안전함 | 예, 모든 위치에서 | 일부 위치에서만 |
| 배포 구성이 명확함 | 예, 모든 위치에서 | 일부 위치에서만 |
예시:
이전: 모듈에 안전하지 않은 배포 구성이 있습니다.
이후: 테스트에 안전한 배포 구성이 있습니다.