[Dart의 정석] Ch2.6. 주석(Comments)

22. 5. 15.

- Could -

이 글은 다트를 공부하고자 하는 모든 사람들을 위한 글이 아니다. 다트라는 언어의 전문가가 되기를 위한 사람들을 위한 글이기 때문에, 프로그래밍을 처음 공부하는 사람들이 보기에는 부적절할 수 있다. 프로그래밍의 초심자라면 본 블로그에 'Dart 입문'을 살펴보거나, 다른 컨텐츠를 찾아 공부하는 편이 더 나을 것이다.
가능한 이해하기 쉽고 일목요연하게 정리하고자 하지만, 다소 설명이 난해하거나 이해하기 어려울 수 있다. 그런 경우 댓글을 통해 궁금한 사항을 남겨두면 필자가 언젠가 보고 좀 더 상세한 설명을 덧붙일 수 있으니 많은 댓글을 바란다.
추가적으로 이 글은 Flutter(플러터)에 대해 다루지 않는다. Dart에 대한 내용만을 다룰 예정이다.

1. 주석(Comment)

주석이라고 적지만 코멘트로 표현하는게 좀 더 이해가 쉽다. 코드에 '사람을 위해' 메모를 남기는 용으로 사용된다. 하지만 매 코드마다 주석을 붙이는 걸 권장하고 싶지는 않다. 코드가 주석없이도 술술 읽히게끔 작성하는게 중요하다.

주석은 꼭 필요한 곳에만 달아주자. 사실 주석을 다는 건 단축기를 이용해 작성중인 코드 뭉치의 일부를 comment-out(주석처리)했다가 취소했다가 하는 기술적인 스킬로 사용되는 경우가 많다.

Dart에서 주석처리는 아래와 같이 이루어진다.

Single-line comments

// 이렇게 주석을 쓴다.
/// 이렇게 써도 된다.

Multi-line comments

/* 
    여러줄의 주석처리가 필요하면
    이렇게도 작성한다.
*/

 

위 내용보다 중요한건 주석을 언제 어떻게 써야하는 지다.

주석을 사용해야할 때

이 부분은 좋은 코드가 무엇인지, 코드를 어떻게 읽기 좋게써야하는지에 대한 고민과 닿아있는 내용이다. 코드는 컴퓨터와 소통하기 위해서 작성하는 거라 생각하지만, 함께 코드를 읽고 작성할 동료들을 비롯한 다른 사람들을 고려해서도 작성해야한다. 무엇보다 읽기좋고 깔끔한 코드를 남겨야하는 이유는 내 코드를 보고 고통받을 미래의 '나'를 위한 배려이다.

주석은 미래의 나를 위해 보내는 메세지로 사용할 수 있다. 하지만 너무 남발하는 것은 좋지않다.

가능한 코드를 주석없이 읽어도 이해할수 있고 작동방식을 추론할 수 있게끔 작성해야하고, 주석은 때려죽여도 여기는 설명이 필요하다 싶은 부분에 남기자. 혹은 내 허접한 실력으로 특정부분의 코드를 엉망으로 짤수 밖에 없었다면, 미래의 나에게 이 부분의 코드를 어떻게 개선했으면 좋겠다는 메세지를 남겨두는 것도 좋다.

 

요약하자면, 주석을 남발하지말고, 꼭 필요한 곳에만 쓰자. 라는 말이다.

(이것저것 만들어보면서 어떻게 쓸지 고민해보는게 좋다.)