Pagsusulat ng mga puna sa mga script ng bash

Kapag nagsusulat ng mga script ng Bash, palaging isang mabuting kasanayan na gawing malinis ang iyong code at madaling maunawaan. Ang pag-aayos ng iyong code sa mga bloke, indenting, pagbibigay ng mga variable at function na naglalarawan ng mga pangalan ay maraming mga paraan upang gawin ito.

Ang isa pang paraan upang mapagbuti ang kakayahang mabasa ng iyong code ay sa pamamagitan ng paggamit ng mga komento. Ang isang puna ay isang paliwanag ng tao na mababasa o annotation na nakasulat sa script ng shell.

Ang pagdaragdag ng mga komento sa iyong mga script ng Bash ay makatipid sa iyo ng maraming oras at pagsisikap kapag tiningnan mo ang iyong code sa hinaharap. Sabihin nating nais mong baguhin ang isang script na isinulat mo ilang buwan o taon na ang nakalilipas. Ang mga pagkakataon ay hindi mo matandaan kung bakit mo isinulat ang ilang mga kumplikadong piraso ng code maliban kung nagdagdag ka ng isang puna.

Tumutulong din ang mga komento sa iba pang mga developer at mga tagapangasiwa ng system na maaaring kailanganin upang mapanatili ang script upang maunawaan ang iyong code at ang layunin nito.

Karaniwang ginagamit ang mga puna upang maipaliwanag kung ano ang hindi magagawa ng code. Halimbawa, kung mayroon kang isang kumplikadong regex o pagpapalit ng parameter sa loob ng iyong script ng Bash, dapat kang sumulat ng isang puna tungkol sa kung ano ang ginagawa ng code. Ang mga puna ay dapat maikli at sa puntong. Huwag ipaliwanag ang isang bagay na simple at halata sa mambabasa.

, tatakpan namin ang mga pangunahing kaalaman sa pagsulat ng mga komento sa Bash.

Pagsusulat ng mga Komento sa Bash

Hindi pinapansin ng Bash ang lahat ng nasusulat pagkatapos ng hash mark ( # ) sa linya. Ang tanging pagbubukod sa panuntunang ito ay kapag ang unang linya sa script ay nagsisimula sa #! mga character. Ang pagkakasunod-sunod ng mga character na ito ay tinatawag na Shebang at ginagamit upang sabihin sa operating system na ginagamit ng tagasalin upang i-parse ang natitirang file.

Ang mga komento ay maaaring maidagdag sa simula sa linya o mag-inline sa iba pang code:

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

Ang blangkong puwang pagkatapos ng hash mark ay hindi sapilitan, ngunit mapapabuti nito ang kakayahang mabasa ng puna.

Karaniwan, kapag binuksan ang script sa isang text editor, ang mga komento ay kinakatawan ng berde.

Ang mga komento ay kapaki-pakinabang din sa pagsubok ng isang script. Sa halip na tanggalin ang ilang mga linya o bloke, maaari mong punain ang mga ito:

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

Mga Komento ng Multiline sa Bash

Hindi tulad ng karamihan sa mga wika ng programming, hindi suportado ni Bash ang maraming mga komento ng multiline.

Ang pinakasimpleng paraan upang makapagsulat ng maraming mga komento sa Bash ay upang magdagdag ng bawat isa sa mga puna:

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

Ang isa pang pagpipilian ay ang paggamit ng HereDoc. Ito ay isang uri ng pag-redirect na nagbibigay-daan sa iyo upang makapasa ng maraming mga linya ng pag-input sa isang utos. Kung ang block ng HereDoc ay hindi nai-redirect sa isang utos, maaari itong maglingkod bilang isang placeholder ng mga komento ng multiline:

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

Ang paggamit ng HereDoc ay isang hack, hindi isang totoong builtin na paraan upang magsulat ng mga komento ng multiline Bash. Upang maiwasan ang anumang mga isyu, dapat mong ginusto ang paggamit ng mga komento na single-line.

Konklusyon

Ang pagsulat ng mga puna ay isang mabuting kasanayan at tumutulong sa iba pang mga developer, kabilang ang hinaharap na sarili, upang maunawaan ang script ng shell. Sa Bash, lahat ng bagay pagkatapos ng hash mark ( # ) at hanggang sa pagtatapos ng linya ay itinuturing na isang puna.

Kung mayroon kang anumang mga katanungan o puna, huwag mag-iwan ng komento.

terminal ng bash