IT/고찰 3

Log에 대한 고찰

2023.08.15 - [IT/고찰] - Comment에 대한 고찰 Commit Message와 Comment에 이은 고찰 시리즈 3탄, Log Log 필요성 로그는 프로세스의 흐름, 장애 파악 등 정보 수집에서 중요한 역할을 담당합니다. 오류가 발생하면 가장 먼저 어디서 잘못되었는지 로그 검색을 통해 정보를 알아냅니다. 하지만 잘못된 로그들은 오히려 개발자들에게 혼란을 가중시킵니다. 또한, 의미없는 로그 데이터들로 인해 중요한 정보를 보기까지 많은 어려움을 겪게 됩니다. 실제로 프로젝트를 진행하면서 정말 중요한 흐름만 기록을 했다면, 에러가 난 부분을 명확하게 표현했다면 간단하게 고쳐질 문제들이 대부분이었습니다. 그러나 그 원인을 찾기까지 정말 수많은 시간을 소모하였습니다. Commit Message,..

IT/고찰 2023.08.25

Comment에 대한 고찰

2023.08.02 - [IT/고찰] - Commit Message에 대한 고찰 Commit Message에 대한 고찰에 이은 고찰 시리즈 2탄 사실 주석은 필요하지 않다 로버트 C 마틴의 Clean Code 책에서 주석은 필요 악인 존재입니다. 주석은 코드로 의도를 표현하지 못해서 남기는 것이라 말하기도 합니다. 2021.10.30 - [IT/책] - [Clean Code] 4장, 주석 [Clean Code] 4장, 주석 Clean Code - 로버트 C. 마틴 4장, 주석 주석은 코드로 의도를 표현하지 못해서, 실패를 만회하기 위해서 사용함 🔴 주석은 필요 악 🔴 - 주석을 유지/보수하기 어려움 - 주석이 코드를 항상 따라가 honeywater97.tistory.com 그리고 주석을 지양해야 하는 이..

IT/고찰 2023.08.15

Commit Message에 대한 고찰

회사 프로젝트를 진행하면서 메시지가 담고 있는 의미에 대해서 종종 생각하게 되었습니다. 코드로 모든 걸 나타낼 수 있다면 가장 좋겠지만, 코드에 온전히 나의 의도를 담는 것은 쉽지 않습니다. 따라서, 가장 자주 사용하는 메시지인 Coimmit, Comment, Log의 작성법에 대해서 정리해보고자 합니다. 메시지를 잘 적는 것은 협업에서 반드시 필요한 기본적인 습관입니다. 기록으로 소통이 가능하기 때문입니다. Commit Message 필요성 1. Git을 사용하면 반드시 커밋 메시지를 남기도록 되어있습니다. 그렇기 때문에 많은 개발자들은 의미없이 커밋 메시지를 적기도 합니다. ex) "제발", "이번엔 성공" 등 2. 커밋메시지는 단순히 소스코드를 올리거나 억울함을 호소하기 위한 것이 아닙니다. 코드의..

IT/고찰 2023.08.02