[ETC]주석에 대한 의견(주관적)

얼마전에 IT 커뮤니티 쪽에 글을 읽어봤는데 아무리 생각해도 내 의견이랑은 안맞는 글을 보았는데.

자바스크립트 아니 모든언어에 대한 주석이 없는 클린코드를 짜라. 라는 말을 들었는데.

왠만하면 그런코드를 지향하겠지만 ~~를 해라! 라고 강조하는건 옳지않다고 생각합니다.

저같은경우 보통 프로그래밍을 하다가 함수, 메서드등을 정의하게된다면

/* ================================================= 

* 함수 설명 : 어떤곳에 뭐하는 함수.

* 중요한 변수값 :

* 특이사항 :         

*

*/

function ~~~~(){

코드

}

이런식으로 정의하곤 합니다.

물론 변수 네이밍과 함수네이밍은 필수지요

제일싫어하는경우가.

예제나 

어떠한 프로그램을 설명할때 aaaa bbbb 를 쓰지만 

실제 서비스하거나 실제로 중요한코드 들은 

aaaa 이런식으로 대충만들지않습니다.

함수명을 selectDBConnect 이런식으로 길게 쓰는거 바라지도 않습니다.

저같은경우에는 보통

sel_DBConn

이런식으로 줄여서 쓰긴합니다.

정말 단어를 조합하다보니 너무너무 길다하는경우에 저위에 함수정의 사전(?) 같은 저만의 표시방법을 이용해 정리하기도 하구요

고리타분할진모르겠지만

제가 이회사에서 얼마나 더일할지 모르고 사람일은 어떻게 될지모르니까  내뒤에 오는 사람을 배려한달까요 

이함수는 도데체무엇이고 무슨일을 하는가.

이걸 함수로 네이밍한걸 알아들으면 상관이없지만 그것조차 안될경우 골머리 썩을수도 있습니다.

5년차. 10년차. 그이상경력자들은 안에 알고리즘만 파악해도 간단한경우 바로 이해가 가능하겠지만

만약 신입개발자 아니면 조금 잘못하는개발자가 생긴다면 그날로 저한테 전화가오거나 그사람이 받을스트레스를 생각하면 괜스레 미안해집니다.

(제가 그렇게 회사 입사하자마자 프로그램을 보는데 진짜 전에 만든사람은 실력은 뛰어나나 진짜 함수명하고 아무런 설명도 포함되어있지않아서  

제방식대로 위에 Function Doc 을만들어서 사용중입니다.)

가독성이 안좋다 어쨌다 하는사람들은 진짜 한번에 이해하는사람만 속하는거고 그것도 안되고 변수 넘어오는 파라미터값 분해해서

 아 이게 배열로 넘어오는구나 이게String 값이구나 아는사람들한텐 필요한거라고 생각합니다.

무조건 주석다는건 실력부족한사람이야 라는 뉘앙스로 말하는사람들이 몇몇있어서 말해봅니다;

유지보수 할때 얼마나 도움이 되는지는 개인판단이겠지만 저 주석 몇개 달았다고 가독성이 떨어진다고 생각절대안합니다.

하지만 정말 쓸때없는 주석은 피해야한다는건 저도 동감합니다.

var view_toogleStatus; //전역변수

코딩한줄한줄 다 주석달아놓는건 보기 안좋은건 맞습니다.

근데 외부프로그램을통해 작동하거나 정말 파악하기 힘든 코드들 그런건 줄주석정도는 이해해줘야 한다고 생각합니다.

그런코드보자마자 

아눈아파 못읽겠어 , 이코드는 정말 누가짰는지 모르겠지만 쓰레기 코드다  라고 말하는건 좀 ...인성의 문제가 있다고 생각되는데...

요약을 하자면 

실제 서비스 할시 

1. 주석이 있다고 쓰레기 코드가 아니다.

2. 함수위에 함수의 동작설명 및 중요한 변수 및 매개변수의 역할 정도는 적어놓는다. (간략하게.)

3. 한줄한줄 주석다는건 되도록이면 하지말자.

4. 절대 고리타분한 생각이 아니다.

5. 자신이 퇴사한후에 같은 개발자로써 매너를 지키자. 

6. 되도록이면 이해하기쉬운 변수,함수 네이밍을 하자.

이정도만 지켜도 될듯싶다.

주석 달면 더럽고 가독성이 떨어진다.

사람을 이해하지 못하는건아니지만 

코드에대한 설명이나 뜻을 기재하는 개발자의 성의나 노력을 무시하지맙시다.