کامنت‌ها

مقدمه

همه‌ی برنامه‌نویسان تلاش می‌کنند که درک کدی که می‌نویسند، تا جای ممکن ساده باشد و اصطلاحاً کدشان خواناتر باشد. اما گاهی اوقات، برای ساده‌سازی کدها به توضیحات بیشتری نیاز است. در این موارد، برنامه‌نویسان از کامنت‌ها (comments) برای افزایش خوانایی برنامه استفاده می‌کنند. کامپایلرها این کامنت‌ها یا توضیحات را نادیده می‌گیرند اما سایر افراد و خود برنامه‌نویس در آینده می‌توانند از این توضیحات برای درک کدها استفاده کنند. در اینجا یک کامنت ساده را می‌بینید.

//hello world

پس، برای ایجاد کامنت در Rust از همان سینتکس آشنای C-style استفاده می‌شود؛ یعنی دو کاراکتر اسلش در ابتدای خط قرار می‌دهیم تا کامپایلر آن خط را کامنت تلقی کند. البته امکان ایجاد کامنت‌های چندخطی هم وجود دارد. کامپایلر همه‌ی خطوط بین /* تا */ را کامنت در نظر می‌گیرد.

  /* So we’re doing something complicated here, long enough that we need
  multiple lines of comments to do it! Whew! Hopefully, this comment will
  explain what’s going on. */

لزومی هم ندارد که یک کامنت از ابتدای یک خط آغاز شود و همانطور که در مثال زیر می‌بینید، می‌توانیم یک کامنت را در انتهای یک خط کد نیز قرار دهیم.

src/main.rs

fn main() {
  let lucky_number = 7; // I’m feeling lucky today
}

اما معمولاً کامنت‌ها را به این فرمت می‌بینیم که کامنت مربوط به هر خط در بالای آن در یک خط مجزا قرار می‌گیرد. مانند زیر:

src/main.rs

fn main() {
  // I’m feeling lucky today
  let lucky_number = 7;
}

در Rust نوع دیگری از کامنت‌ها موسوم به کامنت‌های مستندسازی (documentation comments) نیز وجود دارد که در فصل 14 در مورد آنها صحبت خواهیم کرد اما فعلاً همینقدر بدانید که این نوع کامنت‌ها توسط ابزار rustdoc برای ایجاد مستندات خودکار استخراج می‌شوند.