소스 코드의 주석을 읽어보는 습관을 들이자.

Dong Wook Lee (Michael)·2021년 1월 24일
0

코드숨 과정을 진행하면서, 기계인간님이 클래스 주석을 읽는 습관을 들이면 좋다는 말씀을 하셨다.

예를 들어, String을 사용할 때 내가 String 클래스의 주석을 읽은 적이 있는지 스스로 물어보세요...

자기 반성

이 말을 듣고 내가 이전에 클래스나, 메서드를 사용하면서 주석을 읽은적이 있나 생각을 해보았다.
나는 클래스나 메서드를 사용하다가 이 메서드가 도대체 무엇을 하는 메서드인지 궁금할 때는 그저 구글에 검색해서 대충 예제나, 어떻게 사용하는지 사용법만 확인 한 후에 사용을 했었다.
하지만 이러한 습관을 고쳐야겠다는 생각을 했다. 내가 어떤 것을 사용할 때 그것이 어떤 것인지 정확히 알지도 못하면서 개발을 하는 것은 개발자로써 부끄러운 행동이며 남의 것을 생각없이 가져다 쓰는 것이기 때문이다.
남의 것을 가져다 쓰더라도 이것이 어떤 것인지는 정확히 알고 사용을 해야겠다. 그리고 블로그나, 인터넷에서 이것이 어떤 것인지를 본다고 하더라도, 주석이나 공식 메뉴얼보다는 정확히 설명을 할 수 없고 또한 블로그에 있는 내용이 틀릴 수도 있기 때문이다.

좋은 점

클래스의 주석이나, 공식 메뉴얼을 읽었을 때 좋은 점 중에 하나는 그 함수에 대해서 더 잘 알 수 있으며, 나아가 그 언어의 설계 방침이나 다른 것들을 배울 수 있기 때문이다. 자바 뿐만 아니라, 리눅스 커널 공부를 할 때도 공식 메뉴얼이나 man 페이지를 읽는 습관을 들여서 자주 확인하면서 메뉴얼을 통해서 배우는 습관을 들여야겠다.

profile
오픈소스 메인테이너를 꿈꾸는 개발자!

0개의 댓글