주석에 대하여(작성중)

필요성

문득 나는 코딩하면서 주석 적는 습관이 되어있나 생각해보게 되었어.

지금까지 대부분 주먹구구식의 개발이었고, 개인 프로젝트가 전부였던 내게 주석이란 굳이 필요가 없었던 것 같아.

 

그러나 개발을 학생으로 끝낼 생각이 전혀 없는 나는 개발자가 되기 위해 노력해야겠지.

그러려면 협업을 할 때, 다른 사람이 내가 짠 코드를 유지보수 할 때 주석이 반드시 필요할 것이라고 생각해.

 

서론이 길었는데, 맞아 이번엔 주석에 대해 공부를 좀 해보려고 해.

 

 

주석의 장점

1. 개발자 의도 파악할 수 있다.

 

2. 함수 제목, 변수명 등으로 표시하지 못하는 부분을 표현할 수 있다.

 

3. 기술적 제약을 간단히 기술해주면, 왜 이시점에서 이렇게 코딩 했는지 등을 알려줄 수 있다.

 

 

주석의 단점

1. 유지보수 과정에서 대부분 주석은 지우지도 못하고 변경하기도 애매하게 될 여지가 있다.

 

2. 배포 스크립트에 주석이 달려서 배포될 수 도 있다. -> 보안 및 제품 신뢰도에 지장