[Flutter/Dart] 주석 표기법(Commenting Code)

Dart는 다른 프로그래밍 언어들과 같이 작성한 코드에 주석을 달 수 있도록 하고 있다. 코드와 나란히 주석을 기재하면 되고,  컴파일러는 이 주석부분을 무시한다.

작성하는 코드의 깊이와 복잡성으로 인해 이유에 대한 전체적인 큰 그림이 모호해질 수 있다. 이를 방지하기 위해, 자신의 코드를 짜고나서 다른 사람들이 잘 이해할 수 있도록 주석을 하면 좋다. 어쩌면 당신이 미래의 그 사람일 수도 있다.

(single-line comment) 한 줄 주석은 슬래쉬 2개를 문장 앞에 적는다.

 

 

(multi-line comments) 한 줄 주석을 쌓아서 여러 줄 주석을 작성할 수 있다.

 

 

(comment blocks) 주석 시작에  /*를, 주석 마지막에  */  를 넣는다.

 

 

다음과 같이 안에다 다시 쓰는 것도 가능하다.

 

 

(documentation comments) 한 줄 주석은 ///로 시작하고, 블록구간 문서 주석은  /** 와 */  처리한다.

 

 

문서 주석은 어디에서든지 사용할 수 있기 때문에 매우 유용하다. 공개 API가 있을 때마다, 문서 주석을 추가하여 코드를 보는 뒷사람들이 어떻게 API가 작동하는지 알 수 있다

* API(application programming interface) : 다른 사람들 또는 프로그램들과 공유하는 코드