Komentarze rdzy

Komentarze są niezwykle przydatną funkcją, która pozwala programistom na krótką, ale opisową dokumentację w programie.

Możliwość dodawania komentarzy do kodu może pomóc poprawić czytelność dla Ciebie i innych programistów, którzy mogą odczytać i używać kodu.

Jak działają komentarze?

Komentarze nie są niczym specjalnym. To tylko zestaw znaków tekstowych, które opisują, jak lub co robi kawałek kodu.

Komentarz używa znaków specjalnych, które sprawiają, że kompilator je ignoruje. Omówmy, w jaki sposób możemy wdrożyć i używać komentarzy w naszych programach.

Komentarze rdzy

Istnieją trzy rodzaje komentarzy w rdzy:

1. Proste lub liniowe komentarze
2. Blokuj komentarze
3. Komentarze doktora

Porozmawiajmy.

Proste komentarze linii

Proste lub komentarze linii to rodzaj komentarzy obejmujących jedną linię. Służą głównie do wstawienia krótkiej i opisowej wiadomości do bloku kodu.

W rdzy możemy wstawić komentarze jednolodowe za pomocą znaków podwójnego do przodu. Przykładem jest jak pokazano:

fn main ()
// Komentarz z pojedynczym wierszem
println!("Witaj świecie!");

Jak wspomniano, komentarz jednokierunkowy obejmuje pojedynczy wiersz. Jak pokazano w przykładzie, Compiler z ignoruje linię po 8, dwa znaki do przodu.

Blokuj komentarze

Drugi rodzaj komentarza jest znany jako komentarze blokowe. Są one ściśle podobne do prostego

STTART, otwierając blok komentarzy z postacią do przodu i gwiazdką, jako (/*).

Następnie możemy dodać tekst komentarza i zamknąć blok komentarza za pomocą gwiazdki i luzu jako (*/).

Przykładem komentarza blokowego w rdzy jest jak pokazano:

fn main ()
/*
komentarz blokowy
rozprzestrzenianie się
linie mutliple
*/
println!("Witaj świecie!");

Powyższy kod pokazuje tworzenie komentarza blokowego, który obejmuje wiele wierszy.

Komentarze doktora

Rust dostarcza nam również komentarzy do dokumentu. Istnieją dwa główne rodzaje komentarzy DOC w rdzy:

1. Wewnętrzne komentarze DOC
2. Komentarze zewnętrzne do dokumentu.

Wewnętrzne komentarze DOC

Komentarze wewnętrzne DOC są oznaczone podwójnym cięciem naprzód i hukiem as //!. Są one zapisane w bloku kodu, są używane głównie do generowania dokumentacji kodu w określonym bloku.

Przykładem jest jak pokazano:

fn main ()
//! dokument
println!("Witaj świecie!");

Powyższy kod oznacza wewnętrzny komentarz do dokumentu.

Komentarz zewnętrznego dokumentu

Jak sama nazwa wskazuje, zewnętrzny komentarz do dokumentu odnosi się do komentarza otaczającego zewnętrzny blok kodu i działający jako dokumentacja dla tego bloku.

Komentarze zewnętrzne DOC są oznaczone potrójnymi cięciami do przodu. Pokazany jest przykład:

/// główna funkcja
///
fn main ()
println!("Witaj świecie!");

Wniosek

Ten artykuł pomaga zrozumieć różne rodzaje komentarzy w rdzy i jak tworzyć krótkie i opisowe wiadomości dla bloków kodu.

Mamy nadzieję, że podobał Ci się ten artykuł, dzięki!