dartdoc 주석으로 문서화하기
pub.dev에서 렌더링되는 문서를 작성합니다
dartdoc 주석으로 문서화하기은(는) CoddyKit의 무료 Dart Academy 강의입니다. 이것은 4개 중 2번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 Dart Academy 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. Dart Academy 강의에는 총 4개의 강의가 포함되어 있습니다.
문서는 제품의 일부입니다
훌륭한 패키지는 훌륭한 문서와 함께 제공됩니다. Dart는 특수 주석을 탐색 가능한 참고 문서로 변환하므로 documentation은 나중에 덧붙이는 요소가 아니라 핵심 기능입니다. 📝
세 슬래시 문서 주석
문서 주석은 슬래시 세 개로 시작합니다. 이러한 doc comments는 선언 바로 위에 놓이며 해당 선언이 사용자를 위해 무엇을 하는지 설명합니다.
/// Adds two numbers and returns the sum.
int add(int a, int b) => a + b;한 줄 요약으로 시작하기
모든 문서 주석은 짧은 summary 문장 하나로 시작하세요. 도구가 목록에서 이 첫 줄을 먼저 보여 주므로, 그 자체로 명확하고 완결되게 작성해야 합니다.
Markdown 지원
문서 주석에서는 Markdown을 사용할 수 있으므로 강조, 목록, 링크를 추가할 수 있습니다. 거의 노력하지 않아도 pub.dev의 렌더링된 페이지가 보기 좋게 표시됩니다.
/// Returns the **first** matching item.다른 기호에 연결하기
이름을 대괄호로 감싸면 작동하는 cross-link가 생성됩니다. 독자는 생성된 문서에서 관련 class나 메서드로 바로 이동할 수 있습니다.
/// See [add] for the inverse of [subtract].펜스 블록에 코드 예시 넣기
주석 안의 펜스 코드 블록에 실제 사용 예를 보여 주세요. 짧은 example 하나가 여러 문단보다 빠르게 가르치고, 사용자에게 실제로 작동한다는 확신을 줍니다.
모든 공개 멤버 문서화
각 public class, 함수, 필드를 문서화하세요. 비공개 밑줄 멤버는 설명하지 않아도 되지만, 내보낸 항목에는 반드시 한 문장 이상의 설명을 붙이세요.
라이브러리 수준 문서
전체 파일을 설명하려면 library 지시문 위에 문서 주석을 작성합니다. 이 library comment는 API 해당 부분의 시작 화면에 표시되는 텍스트가 됩니다.
/// Math helpers for everyday use.
library calc;dartdoc으로 사이트 생성
dartdoc 도구를 실행하면 주석이 정적 웹사이트로 변환됩니다. pub.dev는 패키지를 배포할 때 이 작업을 자동으로 수행합니다.
dart doc .문서화 범위로 점수 얻기
pub.dev는 문서가 잘 작성된 패키지에 보상을 제공합니다. 높은 doc coverage는 점수를 올리고 의존성을 선택하는 사람에게 품질을 보여 줍니다. ⭐
코드 가까이에 문서 두기
문서 주석은 코드 옆에 있으므로 함께 쉽게 업데이트할 수 있습니다. 오래된 docs를 버그처럼 여기고 동작이 바뀔 때 수정하세요.
빠른 확인
Dart가 문서 주석으로 취급하는 주석 형식은 무엇인가요?
복습: 렌더링되는 문서
이제 세 슬래시 doc comments를 작성하고, 기호를 연결하고, 예시를 추가하고, dart doc으로 사이트를 생성할 수 있습니다. 명확한 문서가 사용자를 얻습니다. 🙌
자주 묻는 질문
“dartdoc 주석으로 문서화하기” 강의는 무료인가요?
네 — “dartdoc 주석으로 문서화하기” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 Dart Academy 강의 전체를 잠금 해제할 수 있습니다. Dart Academy 강의에는 총 4개의 강의가 포함되어 있습니다.
“dartdoc 주석으로 문서화하기”에서 뭘 배우나요?
pub.dev에서 렌더링되는 문서를 작성합니다 브라우저에서 직접 실행하는 실습 코드로 Dart Academy을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.
Dart Academy을(를) 시작하는 데 경험이 필요한가요?
사전 경험은 필요하지 않습니다. CoddyKit의 Dart Academy은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 2번째 강의입니다.
“dartdoc 주석으로 문서화하기” 강의는 얼마나 걸리나요?
대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.
이 Dart Academy 강의에서 코드를 작성하고 실행할 수 있나요?
네. 모든 Dart Academy 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.
이 강의의 모든 강의
- 배포 가능한 라이브러리 구조화
- dartdoc 주석으로 문서화하기
- 린트, 서식 지정, pana 점수
- dart pub publish로 pub.dev에 게시하기