正确缩进Bash脚本

Question

我已经写了一个Bash脚本，它为大学使用了个案和函数，但无论我在哪里移动脚本，她都说它们没有正确缩进。这个脚本示例的正确缩进是什么？

clear 
     echo "Start A Process" 
echo "*************************" 
echo "1. Oxygen Level." 
echo "***************************" 
echo "2. Temperature ." 
echo "*************************" 
echo "3. Mars Rover Speed." 
echo "*************************" 
echo "4. Satellite Distance" 
echo "*************************" 
echo "5. Carbon Dioxide Level" 
echo "*************************" 
echo "6. Humidity %." 
echo "*************************" 
echo "Press A to quit." 
echo "*************************" 
    read -p "Please make a choice:" choice2 

#Choices 
case "$choice2" in 

1) 
$script/simulate start oxygen 
echo "Oxygen Level Started." 
sleep 5 
;; 
2) 

在VMware上是否有网站或功能可以让我的代码自动缩进？

Answer 1

缩进完成到澄清您的代码。缩进通常用于循环，如果使用语句，函数定义可以很容易地看到哪些语句是该循环的一部分或是if语句的一部分。

使您的代码更具可读性的另一个技巧是添加空白行以分隔出相关代码块。例如，从你的代码的其余部分分离出来你菜单有几个空行：

clear 
echo "Start A Process" 

echo "*************************" 
echo "1. Oxygen Level." 
echo "***************************" 
echo "2. Temperature ." 
echo .... #And on and on... 
echo "*************************" 
echo "6. Humidity %." 
echo "*************************" 
echo "Press A to quit." 
echo "*************************" 

read -p "Please make a choice:" choice2 

case "$choice2" in... 
... 

这使得它更容易看到你呈现的菜单。您也可以使用Here document消除重复的回声和引号，使菜单难以看清。我会消除像星号这样的过分花式的东西。他们不添加任何程序，只是使它难以阅读 - 这两个代码明智和聪明的执行：

clear 

cat <<MENU 
START A PROCESS 
------------------ 
1. Oxygen Level. 
2. Temperature . 
3. Mars Rover Speed. 
4. Satellite Distance 
5. Carbon Dioxide Level 
6. Humidity %. 
A. Quit 
------------------ 
MENU 

read -p "Please make a choice:" choice2 

case "$choice2" in... 
... 

注意如何使用在这里记录让你的菜单很容易看到和格式。

最后，您case声明应该遵循保持公共线缩进的缩进规则，让你不仅知道与case声明而来的代码，但你也缩进每一个选择：

case "$choice2" in 
    1) 
     $script/simulate start oxygen 
     echo "Oxygen Level Started." 
     sleep 5 
     ;; 
    2) 
     ..... 
     ..... 
     ;; 
    ..... 
esac 

一些人们会压缩这一点：

case "$choice2" in 
    1) $script/simulate start oxygen 
     echo "Oxygen Level Started." 
     sleep 5;; 
    2) ..... 
     .....;; 
    ..... 
esac 

缩进几乎是相同的。几条线相结合，使case更紧凑，更易于阅读。

为了帮助您缩进和编码，请使用程序编辑器而不是文本编辑器。像VIM这样的优秀程序编辑器会自动缩进代码，甚至突出显示语法，使其更易于阅读。 Eclipse用于Java编程，但可以用作shell脚本的文本编辑器。一个好的编辑器也可以通过向您显示该命令的手册页来帮助您使用某些语句的命令。当您在VIM中按资本K时，它会显示该命令的联机帮助页。

Bash程序美化非常棘手。但是，有一个Python program将尝试该任务。

Answer 2

正确的缩进取决于所需的样式，这纯粹是一个意见问题。换句话说，唯一可以回答你的问题的人是你称为“她”的神秘女人。就个人而言，我会说你比缩进有更大的问题。而不是从标准输入读取选择，你应该把它作为命令行参数。而不是总是打印一个显示选项的菜单，您应该只打印它们以响应-h或--help或类似的东西。使用单个heredoc打印菜单，而不是使用一串连续的回声。例如：

usage() { cat <<- EOF 
    $(basename $0) option 

    Start A Process, where option is one of: 
    1) oxygen level 
    ... 
    6) Humidity %.  
EOF 
} 

Answer 3

此问题已经在Unix Stack Exchange已被处理。

没有这样的事情作为Bash的标准。通常你缩进至少每个级别：

• 功能
• 环路（for，while）
• 条件语句（if，case）

一些例子：

function echofoo() { 
    echo foo 
} 

或

if true 
then 
    echo foo 
else 
    echo bar 
fi 

或

case "$choice" in 
    1) 
    echo foo 
    ;; 
    2) 
    echo bar 
    ;; 
    [...] 

Answer 4

虽然有对shell脚本没有具体的标准，通用的压痕惯例规定，关于控制的同一级别的命令应该得到相同的缩进，并命令这取决于从结果前一行的控件构造应该相对于该控件构造缩进。在控制结构结束的地方，压痕应该恢复为流控制结构的压痕。

因此，在您的特定示例中，缩进的echo和read语句相对于围绕它们的命令没有很好的原因缩进，并且语句的主体应该缩进。

如果配置正确，大多数不错的编辑会自动为您做这些工作。

clear 
# Really, really recommend turning this into a here document 
echo "Start A Process" 
echo "*************************" 
echo "1. Oxygen Level." 
echo "***************************" 
echo "2. Temperature ." 
echo "*************************" 
echo "3. Mars Rover Speed." 
echo "*************************" 
echo "4. Satellite Distance" 
echo "*************************" 
echo "5. Carbon Dioxide Level" 
echo "*************************" 
echo "6. Humidity %." 
echo "*************************" 
echo "Press A to quit." 
echo "*************************" 
read -p "Please make a choice:" choice2 

#Choices 
case "$choice2" in 
1) 
    $script/simulate start oxygen 
    echo "Oxygen Level Started." 
    sleep 5 
    ;; 
2) 

case声明中的缩进细节不太严格。有些人将个别案例标签缩回到与管理case相同的级别，其他人将其缩进一个完整的级别（这里是四个空格）。我倾向于选择一个中间地带，这样一个案例的主体正好相对于管理的case陈述缩进了四个空格。

Answer 5

风格将永远是一个讨论。一个好的起点是Google's style guide，它也提供了许多shell结构的概述。

我碰巧不赞同谷歌风格的“缩进2空格，没有标签”，我更喜欢标签。一些开发人员喜欢看2个空格，大约4个，并且可以按照自己喜欢的方式进行更改（vi：set tabstop = 3 indent = 3）。

如何显示菜单？ 你可以使用一个回波这样的：

echo "Start A Process 
     1. Oxygen Level. 
     2. Temperature . 
     3. Mars Rover Speed. 
     4. Satellite Distance 
     5. Carbon Dioxide Level 
     6. Humidity %. 

     Press A to quit." 

当你有更多的菜单的，我会考虑使用TEXTFILES与菜单线和cat正确的菜单文件。你可以看到一个例子https://unix.stackexchange.com/questions/38200/ksh-styling-text-based-menu-using-stderr/115371#115371

Answer 6

只需用vim编辑器打开文件并输入gg = G就可以重新整理整个文件。

Answer 7

我发现这个答案here：

Emacs可以做到这一点：在该文件的顶部

• 将文件加载到Emacs的
• 按Ctrl-space
• 将光标移至底部的文件
• 按Alt-x和类型untabify然后返回
• 按Alt-x和类型indent-region然后返回

这将得到正确摆脱标签和缩进一切。

如果您需要更频繁地做到这一点，不要使用Emacs的编辑器，你可能需要将其全部打包成一个脚本：

#!/usr/bin/emacs --script 

(setq require-final-newline 'visit) 

(defun indent-files (files) 
    (cond (files 
     (find-file (car files)) 
     (untabify (point-min) (point-max)) 
     (indent-region (point-min) (point-max)) 
     (save-buffer) 
     (kill-buffer) 
     (indent-files (cdr files))))) 

(indent-files command-line-args-left) 

;; EOF ;;