[💬] [현업개발자] 주석 장단점 알려준다

[익명(124.50)]

그냥 무턱대고 주석이 좋다 나쁘다는 식의 이야기는 

너네의 편협한 이분법적 사고를 보여주는거지

자료구조에 좋은거 나쁜것이 있는게 아니라 모두가 일장일단이 있고 상황에 맞춰 쓰는것처럼

주석도 장단이 있음

장점:

1. 뭐니뭐니해도 개발자 의도를 알려주는데 주석만큼 좋은게 없음. 뭘 하려고 작성한 코드인지, 다른 곳들에 의존성이 걸려있는지, 빼도 되는지, 언제 만든건지, 누가 만든건지 등등.

2. 함수 제목, 변수명 등으로 표시하지 못하는 부분이 분명히 있을 수 있는데 이걸 주석없이 가독성 확보한다고 할 때 되려 코드이 비효율이 발생할 수 있음. 이럴 땐 그냥 주석 한줄 다는게 누가 봐도 편함

3. 위에 이어서, 각 언어의 습성별로 문법이나 순서가 달라지는데, 어떤 언어는 함수를 미리 선언하지 않으면 코드상 뒤에 있는 함수를 불러오지 못하는 등의 제약이 있을 수 있음. 그런 기술적 제약을 간단히 기술해주면, 왜 이시점에서 이 함수를 선언한지 등을 주석을 통해 말해줄 수 있다. 주로 오래된 언어를 사용할 때 유용했던 듯

단점 :

1. 과연 핫픽스를 진행할 때 주석도 업데이트를 해줄까? 유지보수 과정에서 대부분 주석은 지우지도 못하고 변경하기도 애매한 애물단지로 전락하게 됨. 남이 달아 놓은 주석 섣불리 지우기도 쉽지 않음. 결국 코드도 쓰고 주석도 바꿔줘야 함. 코드야 잘못쓰거나 하면 필수적으로 바꿔줘야 한다지만 주석은 귀찮아서 내버려둬도 기능상 아무 지장이 없으니 결국 남이 쓴 주석 잘 바꾸지도 않게되고 자기가 쓴것도 업데이트 안하게 되고 나중에 주석 떡칠이 됨. 

2. 관리툴을 쓰면 보통 해결되지만 사람이 하는 일인지라 배포 스크립트에 주석 주렁주렁 달려서 나가는 경우도 허다함. 일부러 망글링까지 하는 마당에 클라이언트 배포판에 주석이 나간다? 보안은 말할것도 없고 제품 신뢰도까지 지장 줄 수 있다. 안그러면 되지 않냐고? 구글 마소 배포판에도 주석 달려 나오는 경우가 있는데 그걸 누가 담보함?

3. 주석 다는 언어는 어떡할거임? 오픈소스라고 가정하면 코드야 만국공통어지만 분명 한글로 쓰는놈 영어로 쓰는놈 한자 일본어 독일어 난무함. 영어로만 주석 단다고? 여기 개붕이들이 영어로 제대로 주석 달거 같음? 그거 영작할 시간에 코드 퀄리티 높여서 가독성 높이는게 나을수 있음

결론 :

현업에서는 어지간해서는 지양하지만 필요하다고 생각하면 쿨하게 쓴다. (주로 영어로)

주석 기능도 엄연한 보조 기능인데 강박적으로 주석이 없어야 좋은 코드다! 할건 아니지만 기왕이면 안쓰려고 해보고 정 필요하면 최소화해서 쓰면 그만임

협업이 필수인 현업에서 해당하는 이야기고 나는 죽어도 혼자만 개발할거고 이 프로젝트도 나 외엔 건들사람 없다면 왓에버 꼴리는 대로 하면 됨.

[익명(117.111)]

이게 맞음. 다다익선이 절대 아님

[익명(124.50)]

ㅇㅇ 기왕이면 줄여봐야지.

[raveneer(175.223)]

모든 방법론이 케이스 바이 케이스라는 걸 깨닫기까지 넘 오래걸림

[익명(124.50)]

ㅇㅇ 개 걸 윷 있는데 모아니면 도일 필요는 없지

[익명(223.38)]

혼자 코딩하는 아싸 인붕이들은 마음대로 하면 됨

[익명(124.50)]

그것도 맞다.

[김메가(scw973108)]