문서 주석은 ///로 쓰기
문서 주석은 ///로 쓰기
Dart의 문서 주석(doc comment)은 블록 주석 스타일(/** ... */)보다 줄 끝 스타일(///)로 쓰는 것이 관례이고 더 읽기 편해요. 이 진단은 문서 주석에 블록 주석 스타일을 사용했을 때 이를 안내합니다.
본문
진단 내용
Dart analyzer는 문서 주석이 /**와 */로 구분되는 블록 주석 스타일을 사용할 때 이 진단을 내보내요.
예제
다음 코드는 f에 대한 문서 주석이 블록 주석 스타일이라서 이 진단이 발생해요:
/**
* Example.
*/
void f() {}
고치는 방법
줄 끝 주석 스타일을 사용하면 돼요:
/// Example.
void f() {}