Коментари във вашия рубин код са бележки и пояснения, предназначени за четене от други програмисти. Интерпретаторът Ruby пренебрегва самите коментари, така че текстът в коментарите не подлежи на никакви ограничения.
Обикновено е добра форма да се правят коментари преди класове и методи, както и всяка част от кода, която може да е сложна или неясна.
Използване на коментарите ефективно
Коментарите трябва да се използват за даване на основна информация или коментиране на труден код. Забележки, които просто казват това, което прави следващият ред на пряк код, са не само очевидни, но и добавят елементарност към файла.
Важно е да внимавате да не използвате твърде много коментари и да сте сигурни, че коментарите, направени във файла, са смислени и полезни за другите програмисти.
Шебангът
Ще забележите, че всички Ruby програми започват с коментар, който започва с #!. Това се нарича a вертеп и се използва в Linux, Unix и OS X системи.
Когато изпълнявате сценарий на Ruby, черупката (като bash на Linux или OS X) ще търси шебанг в първия ред на файла. След това черупката ще използва shebang, за да намери интерпретатора Ruby и да изпълни скрипта.
Предпочитаният Ruby shebang е #! / usr / bin / env рубин, въпреки че може и да видите #! / ЮЕсАр / хамбар / рубин или #! / ЮЕсАр / местни / хамбар / рубин.
Едноредови коментари
Коментарът на едноредовия Ruby започва с # символ и завършва в края на реда. Всякакви герои от # символа до края на реда се игнорира напълно от интерпретатора на Ruby.
Най- # символът не е задължително да се появява в началото на реда; може да се появи навсякъде.
Следващият пример илюстрира няколко употреби на коментари.
#! / usr / bin / env рубин
# Този ред се игнорира от преводача Ruby
# Този метод отпечатва сумата от своите аргументи
деф сума (a, b)
поставя + b
край
sum (10,20) # Разпечатайте сумата от 10 и 20
Многоредови коментари
Въпреки че често се забравя от много Ruby програмисти, Ruby има многоредови коментари. Многоредовният коментар започва с = започне знак и завършва с = край жетон.
Тези символи трябва да започват в началото на линията и да са единственото нещо на линията. Интерпретаторът на Ruby не пренебрегва нищо между тези два маркера.
#! / usr / bin / env рубин
= започне
Между = начало и = край, произволно число
от редове могат да бъдат написани. Всички тези
линиите се игнорират от преводача Ruby.
= край
поставя "Здравей свят!"
В този пример кодът ще се изпълни като Здравей свят!