jaké jsou komentáře v Ruby?
komentář Ruby přidává do vašeho kódu informace, které mohou být užitečné pro vás nebo jiné vývojáře.
nejběžnějším typem komentáře je jednořádkový komentář.
zde je syntaxe:
# I like apples & oranges
Všimněte si tří věcí:
- komentář začíná libra (
#) symbol - dali Jsme prostor mezi obsah komentář & začátek komentář, aby bylo snazší číst
- Všechno uvnitř komentář není interpretován jako kód, i když to vypadá jako kód. To znamená, že můžete dočasně komentovat kód a deaktivovat jej.
můžete použít tyto komentáře na vlastní pěst, nebo inline, na konci řádku kódu.
.size # get array size
existují i jiné druhy komentářů?
ano, existují magické Komentáře, víceřádkové Komentáře & erb Komentáře.
pojďme prozkoumat ty!
jak používat víceřádkové komentáře v Ruby
v Ruby děláme víceřádkové Komentáře s pravidelnými jednořádkovými komentáři.
někteří lidé nazývají tyto „blokové Komentáře“.
zde je příklad:
# aaa# bbb# ccc
to je přesně to, jak komentovat blok kódu v ruby.
Moderní editory kód umožní vybrat blok kódu & komentář vše pomocí klávesové zkratky, takže neexistuje žádné další úsilí.
ale existuje speciální víceřádková syntaxe komentářů.
vypadá to takto:
=beginThis is a comment...abc=end
Nikdo používá tuto syntaxi…
je To ošklivé & nemůžete ani použít uvnitř něco, co je členité (jako metoda), ale jeho dobré vědět, že existuje, pokud jste někdy najít v přírodě.
Výstroj Komentáře
shebang (#!) je zvláštní druh komentář, který říká, Unix shell (třeba bash), jak interpretovat tento soubor.
Když přidáte tento komentář v horní části souboru…
Budete moci spustit Ruby soubory jako spustitelné soubory, za předpokladu, že mají správné oprávnění.
Tady je to, co shebang komentář vypadá:
#!/usr/bin/env ruby
To také umožňuje nastavit konkrétní možnosti příkazového řádku, jako varování možnost.
příklad:
#!/usr/bin/env ruby -w
pokaždé, když spustíte tento kód, bude spuštěn s těmito možnostmi, takže je nemusíte předávat ručně.
jak používat magické Komentáře
magický komentář nějakým způsobem mění chování tlumočníka Ruby.
například:
komentář frozen_string_literals způsobí, že vaše řetězce ve výchozím nastavení zamrznou.
vypadá to takto:
# frozen_string_literal: true
další magický komentář umožňuje změnit kódování souboru.
zde je příklad:
# encoding: utf-8
a tady je zajímavý, warn_indent komentář:
# warn_indent: true
zobrazí se varování, kdykoli je vaše odsazení špatné.
Příklad:
def comments end
Které výsledky v:
warning: mismatched indentations at 'end' with 'def' at 3
ERB Komentáře
Pokud používáte ERB pro vaše Kolejnice názory & potřebujete přidat komentář…
Pak můžete použít tuto syntaxi:
nejsem velký fanoušek tohoto, protože věřím, že byste měli mít většinu své logiky z vašich názorů, takže byste neměli potřebovat žádné komentáře.
chcete zakázat nějaký kód pro ladění?
pak odstraňte tento kód & důvěřujte git nebo jakémukoli systému pro správu verzí, který používáte.
souhrn
