당신의 주석 한 줄, 다른 개발자의 생명을 살릴 수 있습니다

얼마 전에 자바스크립트 20년차 개발자처럼 주석 쓰는 법! 이라는 영상을 봤다.

https://www.youtube.com/watch?v=ORmnc-hLrYs 

핵심은 /** */를 활용해서 @return, @param 등을 다는 거였다.

함수 위에 이런 주석을 달아두면, 실제 함수를 사용하는 곳에서 쉽게 주석 내용을 확인할 수 있다는 게 엄청난 강점이었다. 특히 공통으로 사용하는 함수 같은 건 필수일 듯.

 

요즘 퇴사한 분들의 코드를 매일매일 분석하고 있는데, 코드 정리 + 주석 달기를 하며 파악 중이다. 확실히 파악 속도가 빠르고, 문서화는 덤이다. 나름 재밌음! 

/**
* 업무구분에 따라 번호 다르게 보여주기 
* @param {string} param
*/
const onDvsCdChange = (param) =>{
	~
}

 

또 코드의 가독성이 중요하구나 느낌. 깔끔한 코드도 중요하지만, 매끄러운 변수명과 주석이 가독성을 크게 높여주는 거 같음. chk, cnt 이런 식으로 변수명을 지으면 이 변수가 무슨 역할을 하는지 바로 알지 못하므로 하나하나 로직을 까봐야 함.

 

따라서 변수에 목적성이 담기게 하는 것이 중요

너무 로직이 복잡하면 주석을 추가하기. 

 

변수명에 목적을 담는 게 중요한 만큼. 변수로 자주 쓰이는 영단어가 뭔지 알아봐야겠다 ㅋㅋ

개발자의 글쓰기라는 책 사놨는데, 드디어 읽을 때가 온 거 같다.