Rust

주석

모든 프로그래머들은 쉽게 이해되는 코드를 작성하기 위해 노력하지만, 종종 부연 설명이 필요할 때도 있습니다. 그런 경우 프로그래머들은 주석(comment) 을 코드에 남겨서, 컴파일러는 이를 무시하지만 코드를 읽는 사람들은 유용한 정보를 얻을 수 있게끔 합니다.

의도와 제약를 중심으로 주석의 판단 흐름을 읽습니다.

핵심 흐름

1

주석 작성 실전 기준

주석은 코드의 동작을 반복 설명하기보다, 코드만으로 드러나지 않는 의도와 제약을 기록할 때 가장 효과적입니다.

2

주석 품질 점검 기준

코드 리뷰 단계에서는 주석이 있는지보다 주석이 정확한지를 먼저 확인해야 합니다.

3

의도

모든 프로그래머들은 쉽게 이해되는 코드를 작성하기 위해 노력하지만,종종 부연 설명이 필요할 때도 있습니다.

4

제약

그런 경우 프로그래머들은주석(comment) 을 코드에 남겨서, 컴파일러는 이를 무시하지만코드를 읽는 사람들은 유용한 정보를 얻을 수 있게끔 합니다.간단한 주석의 예를...