Practical Go - Comment

좋은 코드에는 많은 주석이 있고, 나쁜 코드에는 많은 주석이 필요하다.

주석은 Go 프로그램의 가독성을 위해 매우 중요하다.

• 주석은 그 일이 무엇을 하는지 설명해야 한다.
• 주석은 그 일이 하는 일을 설명해야 한다.
• 주석은 그 이유를 설명해야 한다.

Comments on variables and constants should describe their contents not their purpose

변수와 상수에 대한 주석은 목적이 아닌 내용을 설명해야 한다.

함수를 작성하기 전에 함수를 설명하는 주석을 작성해라. 주석을 작성하기 어렵다면 작성하려는 코드가 이해하기 어려울 것이라는 신호다.

 

출처 : Practical Go: Real world advice for writing maintainable Go programs