التعليقات في Rust

تعليقات Rust مشابهة لتعليقات لغات البرمجة الأخرى (C، Java) وتدعم نوعين من التعليقات:

// هذا هو النوع الأول من التعليقات
/* هذا هو النوع الثاني من التعليقات */　
/*　
　* تعليقات متعددة الأسطر
　* تعليقات متعددة الأسطر
　* تعليقات متعددة الأسطر
　*/

تعليقات توضيحية

يمكن استخدام // في Rust لجعل كل ما يليه حتى أول سطر فارغ يصبح تعليقًا.

بموجب هذه القواعد، تكون الثلاثة شرطات العكسية ما زالت تعتبر بداية تعليق صالح. لذا يمكن استخدام Rust /// كتعليق بداية وثيقة التوضيح:

/// Adds one to the number given.　
///　
/// # Examples　
///　
/// ```　
/// let x = add(1, 2);　
///　
/// ```　
fn add(a: i32, b: i32) -> i32 {　
　　　　return a + b;　
}　
　　　　
fn main() {　
　　　　println!("{}",add(2,3));　
}

سيكون لدي الوظيفة add في البرنامج تعليقًا جميلًا يمكن عرضه في IDE:

نصيحة:يحتوي Cargo على وظيفة cargo doc، يمكن للمطورين استخدام هذا الأمر لتحويل التعليقات التوضيحية في المشروع إلى وثائق توضيحية بتنسيق HTML.