주석을 작성할 때는 코드의 동작 방식에 대해 설명하는 것이 아니라(이미 코드를 읽으면 그 동작 방식은 알 수 있기 때문에), 왜 그렇게 구현이 됐는지에 대한 “이유” 와 그렇게 구현하여 얻는 이득/목적에 대해서 설명하는 것이어야 한다.
그리고 그런 주석마저 필요없을 정도의 설계/코드로 잘 표현하는 것이 더 중요하다.
또한 변수 이름을 지을 때 “유의미”한 것으로 잘 선별해야한다는 것도 아주 중요한데 가끔 “List<String> stringList” 따위처럼 지어져있는 변수명을 볼때면 그 변수가 어떤 목적으로 쓰이는지, 파악하는 데에 비용이 발생할 뿐더러 작성자의 의도를 잘못 파악할 수 있는 가능성을 낳는 것이라서 읽는 입장에서는 작성자의 의도를 파악하는데 많은 에너지를 써야해서 매우 피곤해진다.
그리고 변수명 길이에 엄격한 제한을 둬서 fully meaningful 한 변수 이름을 짓기 힘들게 만드는 linter 같은 툴도 현대의 개발 환경(eg. 큰 모니터)에서는 다시 생각해볼 필요가 있지 않을까?
반응형