Megjegyzések írása bash szkriptekkel

A Bash-szkriptek írásakor mindig jó gyakorlat, hogy kódját tisztává és könnyen érthetővé tegyék. A kód tömbökbe rendezése, behúzás, a változókat és a függvényeket leíró nevek megadása többféle módon történik.

A kód olvashatóságának javításának másik módja a megjegyzések használata. A megjegyzés emberi olvasható magyarázat vagy megjegyzés, amelyet a shell parancsfájl ír be.

Megjegyzések hozzáadásával a Bash-szkriptekhez sok időt és energiát takarít meg, amikor a jövőben megnézi a kódját. Tegyük fel, hogy meg akarja változtatni egy olyan szkriptet, amelyet néhány hónappal vagy évvel ezelőtt írt. Valószínűleg nem fogja emlékezni arra, hogy miért írt néhány bonyolult kódot, hacsak nem adott hozzá megjegyzést.

A megjegyzések segítséget nyújtanak más fejlesztőknek és rendszergazdáknak is, akiknek szükség lehet a szkript fenntartására, hogy megértsék az Ön kódját és céljait.

A megjegyzéseket általában annak megmagyarázására használják, hogy mi nem a kód. Például, ha komplex regex vagy paraméter-helyettesítő van a Bash-szkriptben, akkor írjon egy megjegyzést a kód működéséről. A megjegyzéseknek rövidnek és lényegre törőnek kell lenniük. Ne magyarázza meg az olvasó számára egyszerű és nyilvánvaló dolgot.

, a Bash nyelven megjegyzések írásának alapjait fedjük le.

Megjegyzések írása Bash-ban

Bash figyelmen kívül hagy mindent, amit a vonal hash jelének ( # ) után írnak. Az egyetlen kivétel e szabály alól, ha a szkript első sora a #! karakterek. Ezt a karaktersorozatot Shebang-nek hívják, és arra használják, hogy az operációs rendszer megmondja, melyik tolmácsot használja a fájl többi részének elemzésére.

A megjegyzéseket a sor elejére vagy más kóddal beillesztheti:

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

A kivonatjel utáni üres hely nem kötelező, de javítja a megjegyzés olvashatóságát.

Általában, amikor a szkriptet egy szövegszerkesztőben megnyitják, a megjegyzések zölden jelennek meg.

A megjegyzések szintén hasznosak egy szkript tesztelésekor. Néhány sor vagy blokk törlése helyett kommentálhatja őket:

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

Többvonalas megjegyzések Bash-ban

A legtöbb programozási nyelvvel ellentétben a Bash nem támogatja a többvonalas megjegyzéseket.

A sokvonalas megjegyzés Bash-ban történő írásának legegyszerűbb módja az egyes megjegyzések egymás utáni hozzáadása:

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

Egy másik lehetőség a HereDoc használata. Ez egy olyan átirányítás, amely lehetővé teszi, hogy több bemeneti sort átadjon egy parancsnak. Ha a HereDoc blokkot nem átirányítják egy parancsra, akkor többsoros megjegyzés helyőrzőként szolgálhat:

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

A HereDoc használata hack, nem valódi beépített módszer többvonalas Bash-megjegyzések írására. Bármilyen probléma elkerülése érdekében inkább az egysoros megjegyzéseket használja.

Következtetés

A megjegyzések írása jó gyakorlat, és segít más fejlesztõknek, beleértve a jövõket is, megérteni a shell parancsfájlt. Bash-ban mindent, ami a hash jel után ( # ) és a sor végéig megjegyzésnek tekintik.

Ha bármilyen kérdése vagy észrevétele van, nyugodtan írjon megjegyzést.

bash terminál