編寫 shell 命令列程式碼示例的指南

Shell 是一個等待您輸入命令並按回車鍵的程式。為了指示您應該輸入哪些命令，MDN Web 文件上的內容將它們列在程式碼塊中，類似於程式碼示例。

這樣的程式碼塊看起來像這樣

# This may take a while...
git clone https://github.com/mdn/content
cd content

關於正確縮排、空格和行長的觀點一直存在爭議。關於這些主題的討論會分散建立和維護內容的注意力。

在 MDN Web 文件中，我們使用 Prettier 作為程式碼格式化程式，以保持程式碼風格一致（並避免無關緊要的討論）。您可以參考我們的 配置檔案 來了解當前規則，並閱讀 Prettier 文件。

Prettier 格式化所有程式碼並保持風格一致。然而，您還需要遵循一些額外的規則。

編寫 shell 程式碼塊時

• 不要在 shell 指令的開頭包含 $ 或 >。它會造成更多混亂，而不是幫助，而且在複製指令時沒有用。
• 註釋以 # 開頭。
• 在 markdown 中選擇“bash”來指示語言。

Django 伺服器端開發文件 展示了 shell 命令列命令的良好實踐演示。