Kommenttien kirjoittaminen bash-komentosarjoilla

Kun kirjoitat Bash-skriptejä, on aina hyvä tapa tehdä koodistasi puhdas ja helposti ymmärrettävä. Koodin järjestäminen lohkoissa, sisennykset, muuttujien ja funktioiden kuvaavien nimien antaminen ovat useita tapoja tehdä tämä.

Toinen tapa parantaa koodisi luettavuutta on käyttää kommentteja. Kommentti on ihmisille luettava selitys tai huomautus, joka kirjoitetaan komentosarjan käsikirjoituksessa.

Kommenttien lisääminen Bash-skripteihisi säästää paljon aikaa ja vaivaa, kun tarkastelet koodiasi tulevaisuudessa. Oletetaan, että haluat muuttaa komentosarjan, jonka kirjoitit muutama kuukausi tai vuosi sitten. On mahdollista, että et muista miksi kirjoitit monimutkaisen koodin, ellet lisännyt kommenttia.

Kommentit auttavat myös muita kehittäjiä ja järjestelmänvalvojia, joiden on ehkä pidettävä komentosarja yllä ymmärtääksesi koodiasi ja sen tarkoitusta.

Kommentteja käytetään yleensä selittämään, mitä koodi ei voi. Jos esimerkiksi Bash-komentosarjan sisällä on monimutkainen regeksi tai parametrikorvaus, sinun tulee kirjoittaa kommentti koodin toiminnasta. Kommenttien tulisi olla lyhyitä ja tosissaan. Älä selitä jotain, joka on yksinkertainen ja selvä lukijalle.

, käsittelemme kommenttien kirjoittamisen perusteet Bash-kielellä.

Kommenttien kirjoittaminen Bash-kielellä

Bash ohittaa kaiken, mikä on kirjoitettu rivin hash-merkin ( # ) jälkeen. Ainoa poikkeus tähän sääntöyn on, kun komentosarjan ensimmäinen rivi alkaa numerolla #! merkkiä. Tätä merkkijonoa kutsutaan Shebangiksi, ja sitä käytetään kertomaan käyttöjärjestelmälle, mitä tulkkia käytetään jäsentämään loput tiedosto.

Kommentit voidaan lisätä rivin alkuun tai riviin muun koodin kanssa:

# This is a Bash comment. echo "This is Code" # This is an inline Bash comment.

Tyhjä tila hash-merkin jälkeen ei ole pakollinen, mutta se parantaa kommentin luettavuutta.

Yleensä, kun skripti avataan tekstieditorissa, kommentit esitetään vihreänä.

Kommentit ovat hyödyllisiä myös komentosarjan testaamisessa. Joidenkin rivien tai lohkojen poistamisen sijaan voit kommentoida niitä:

# if]; then # echo "Variable is greater than 10." # fi

Moniriviset kommentit Bashissa

Toisin kuin useimmat ohjelmointikielet, Bash ei tue monirivisiä kommentteja.

Yksinkertaisin tapa kirjoittaa monirivisiä kommentteja Bashissa on lisätä yksittäisiä kommentteja peräkkäin:

# This is the first line. # This is the second line.

Toinen vaihtoehto on käyttää HereDocia. Se on eräänlainen uudelleenohjaus, jonka avulla voit siirtää useita syöttöriviä komennolle. Jos HereDoc-lohkoa ei johdeta komentoon, se voi toimia monirivisten kommenttien paikkamerkkinä:

<< 'MULTILINE-COMMENT' Everything inside the HereDoc body is a multiline comment MULTILINE-COMMENT

HereDocin käyttö on hakkerointi, ei todellinen rakennettu tapa kirjoittaa monirivisiä Bash-kommentteja. Ongelmien välttämiseksi kannattaa mieluummin käyttää yhden rivin kommentteja.

johtopäätös

Kommenttien kirjoittaminen on hyvä käytäntö, ja se auttaa muita kehittäjiä, myös tulevaa itseä, ymmärtämään komentosarjan. Bash-muodossa kaikkea hash-merkin ( # ) jälkeen ja rivin loppuun asti katsotaan kommenttina.

Jos sinulla on kysyttävää tai palautetta, jätä kommentti.

bash-terminaali