셩잇님의 잡동사니

1. 코드 내용을 그대로 반복하는 (추가 정보가 없는) 주석은 적지 말라. 2. 좋은 주석은 불명확한 코드를 변명하지 않는다. - 주석으로 코드를 설명하지 말고 코드를 다시 써라. 3. 명확한 주석을 적을 수 없다면 코드에 문제가 있을 수 있다. - 코드가 어렵다고 주석으로 경고하지 말고 코드를 다시 써라. 4. 주석은 혼란을 야기하는 것이 아니라 해소해야 한다. - 주석을 보고 더 헷갈린다면 그 주석은 지워라. 5. 관용적이지 않은(unidiomatic) 코드는 주석으로 설명하라. - 불필요하거나 중복된다고 생각할 수 있는 코드, 이로 인해 다른 누군가가 "단순화"할 수도 있다고 생각되는 코드에는 주석을 달아 설명하는 것이 좋다. 6. 복사한 코드라면 원본 출처 링크를 주석에 포함하라. - 향후 코드를..

Q. 주석 사용에 있어 두 가지 의견이 있는 것 같은데요..! 다른 개발자 분들은 주석을 어느정도로 사용하는지 궁금해서 질문 남깁니다. 1) 주석을 최대한 줄이고 네이밍이나 로직등 코드만 보고 알 수 있게 작성해야 한다. 2) 복잡한 로직은 다른 사람이 이해하기 쉽게 주석을 남긴다. 주석에 대해 어떤 의견을 갖고 계신가요? A. 1, 2번 중에 뭐가 더 좋다라고 명쾌하게 말을 할 수는 없겠지만, ‘최대한 코드만 보고도 이해할 수 있게 코드를 짜는 것을 지향하면 좋다.’ 라고 말씀드리고 싶습니다. 이렇게 코드를 짜려는 연습을 하려면 코드를 짜기 전에도 설계도와 같은 그림을 그리게 되고, 그러면 최소한의 방향성이 생깁니다. 100% 그 방향대로 가지 못하더라도 탈선은 하지 않을 수 있다는 점에서 코드만 보고..