مستندات

Rust دارای مستندات گسترده‌ای است. به عنوان مثال:

  • تمام جزئیات مربوط به حلقه‌ها.
  • تایپ‌های ابتدایی مانند u8.
  • تایپ‌های کتابخانه استاندارد مانند Option یا BinaryHeap.

در واقع، شما می‌توانید کد خود را مستند کنید:

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

محتویات به‌عنوان Markdown پردازش می‌شوند. تمام crate‌های کتابخانه‌ای منتشرشده Rust به‌طور خودکار در docs.rs با استفاده از ابزار rustdoc مستند می‌شوند. مستند کردن تمام آیتم‌های عمومی در یک API با استفاده از این الگو به‌طور رایج مرسوم است.

برای مستند کردن یک آیتم از درون خود آیتم (مانند درون یک ماژول)، از !// یا /* .. !*/ استفاده کنید که به آن “کامنت‌های مستندات داخلی” می‌گویند:

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Speaker Notes

 This slide should take about 5 minutes.
  • مستندات تولیدشده برای rand crate را در https://docs.rs/rand به دانش‌آموزان نشان دهید.