[프로그래밍] 주석 쓰기 팁

https://stackoverflow.blog/2021/07/05/best-practices-for-writing-code-comments/

Best practices for writing code comments - Stack Overflow Blog

 

 

Rule 1: Comments should not duplicate the code.

코드을 복사해 주석에 써서 중복되게 하면 안된다.

 

Rule 2: Good comments do not excuse unclear code.

좋은 주석은 불분명한 코드를 변명하지 않는다.

 

Rule 3: If you can’t write a clear comment, there may be a problem with the code.

주석을 명확하게 쓸 수 없다면 코드에 문제가 있을 수 있다.

 

Rule 4: Comments should dispel confusion, not cause it.

주석은 혼란을 없애야지 야기해서는 안된다.

 

Rule 5: Explain unidiomatic code in comments.

비관용적 코드(통상적으로 잘 쓰지 않는 코드)는 주석으로 설명하라

 

Rule 6: Provide links to the original source of copied code.

복사한 코드의 원보 링크 포함하기

 

Rule 7: Include links to external references where they will be most helpful.

도움이 될만한 외부 참조 링크 첨부하기

 

Rule 8: Add comments when fixing bugs.

버그 수정 후 주석 달기

 

Rule 9: Use comments to mark incomplete implementations.

불완전한 구현 표시를 주석으로 하기