در زبانهای برنامهنویسی توضیحات برای مقاصدی چون توضیح نحوهی عملکرد کد، مستندسازی و ثبت توضیحات حقوقی مانند کپیرایت و لیست توسعهدهندگان و مواردی ازین دست مورد استفاده قرار میگیرد.
بخش زیادی از کدها برای استفاده در آینده و قابل فهم بودن برای بقیه ی برنامه نویسان نیازمند توضیحاتی هستند. توضیحات خطوطی از برنامه اند که در روند اجرای برنامه تاثیری نداشته و صرفا برای روشن بودن کدهاست.
در روبی به دو روش توضیحات نوشته میشوند : توضیحات تک خطی و توضیحات چند خطی.
توضیحات تک خطی
توضیحات تک خطی با علامت # شروع میشوند و هر خطی که با # شروع شود به عنوان توضیح در نظر گرفته میشود :
#This is an inline-comment
#and This is another comment
همچنین میتوان از این توضیحات در بین کدها استفاده کرد و از هرکجای خط علامت # درج شود مابقی آن خط به عنوان توضیح درنظر گرفته میشود :
puts "Hi" # Here is comment
توضیحات چند خطی
توضیحات چند خطی برای نوشتن توضیحاتی که بیشتر از یک خط جا نیاز دارند استفاده میشود. در روبی توضیحات چند خطی بصورت زیر استفاده میشوند یعنی با یک خط حاوی =begin شروع میشوند در خطوط بعدی توضیحات نوشته شده و در آخر نیز توضیحات با =end پایان میپذیرند :=begin
This
is
a
multi-line
comment
=end