5.2. Osadzanie dokumentacji w treści skryptu
Problem
Chcemy w łatwy sposób udostępnić użytkownikom skryptu odpowiednio sformatowaną dokumentację (np. w formie strony podręcznika systemowego lub stron HTML). Kod i dokumentacja powinny być zapisywane w tym samym pliku, gdyż ułatwi to uaktualnianie, dystrybucję i nanoszenie poprawek w skrypcie.
Rozwiązanie
Dokumentację można włączyć do skryptu za pomocą instrukcji „nierobienia niczego” (znak dwukropka) i operatora osadzonego dokumentu.
#!/usr/bin/env bash # plik receptury: embedded_documentation echo 'W tym miejscu można wpisać kod skryptu' # Aby osadzić dokumentację, wystarczy zastosować znak : i mechanizm osadzania # dokumentów : <<'END_OF_DOCS' W tym miejscu można wstawić treść dokumentacji w formacie ...
Get Bash. Receptury now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
