210305_B책_주석 처리된 코드 제거

정재현·2021년 3월 5일
0

TIL2

목록 보기
5/79

오호 오늘은 3.2<주석 처리된 코드 제거>를 진행한다.
내용은 간단하다.
전에 있던 코드를 주석처리하고 냅두면 오히려 혼란만 가중시킨다는 내용이다.

대규모 코드 기반에는 주석 처리된 코드 영역이 항상 있는데, 이러한 종류의 주석은 잡동사니일 뿐이라고 한다.
=>(맞다. 우리 업무에도 주석처리된 코드가 꽤 많다.)
주석 처리된 코드는 심각한 문제 중 하나인데
일반적인 주석과 달리 명확히 설명해주는 역할을 하지 않기 때문.
혼란만 가중시킬 쓰레기를 코드에 끼얹는 셈이라고 한다.
=>(그런데, 난 이렇게 생각하지 않는다. 주석 처리된 몇 줄의 코드는 히스토리를 빠르게 알아볼 수 있기 때문에, 몇 줄은 있어도 되지 않을까? 물론 이 내용도 뒤에 나온다.)

대부분의 프로그래머는 특정 기능이 동적하지 못하게 하려고 코드를 주석 처리한다.
때로는 훗날 다시 사용할지 모르는 코드를 잃어버리고 싶지 않아 주석처리를 한다.
=>(이게 그나마 나의 의견.)

다행히 주석 처리된 코드는 처리하기 무척 쉬운데, 그냥 지우면 된다.
왜냐하면 프로젝트를 진행하는 크고 작은 집단들은 요즘 시대에 거의 git같은 코드 관리 프로그램을 사용하기 때문인데,
git에 히스토리가 다 남아있기 때문이다. 제거, 변경, 추가 모든 사항이 다!
=>(이것도 맞다. git에서 볼 수 있긴하지만 정말 규모가 큰 코드의 히스토리를 git에서 보려면 시간이 꽤 걸린다. 찾는 시간.
그래서 나는 git에서 보는 것보다 일정 기간동안은 주석 처리한 코드가 있어도 되지 않을까 싶다. 하지만 역시 이것 또한 완벽한 대안은 아니라고 생각한다. 그 영역의 그 코드를 팀원들 중 누군가가 계속 예의주시하고 있을 순 없다고 생각하기 때문. 역시 이러한 부분은 팀원들과의 커뮤니케이션을 통해서 convention을 만들어가야 맞지 싶다.)

지은이는 지금까지 프로젝트에서 주석 처리된 코드 주석을 해제한 개발자를 한 번도 본 적이 없다고 한다.
오히려 모두 지우려고했지.
=>(음.. 생각해보니 나는 지우려고도 해봤고 주석을 해제한 적도 몇 번 있는 것 같은데.. 대부분 element의 정보 finder할 때.)

오늘의 코멘트: 주석 처리된 코드에 관하여 알아봤는데, 지은이는 제거를 요구하지만 나는 팀원들과의 커뮤니케이션을 통한 convention을 먼저 성립하고 그 이후에 실행하는게 맞다고 생각한다.

profile
"돈받고 일하면 프로다"

0개의 댓글