shell使用详解，flutter下拉

每个文件的开头是其文件内容的描述。

每个文件必须包含一个顶层注释，对其内容进行简要概述。版权声明和作者信息是可选的。

例如：

#!/bin/bash

Perform hot backups of Oracle databases.

功能注释

任何不是既明显又短的函数都必须被注释。任何库函数无论其长短和复杂性都必须被注释。

其他人通过阅读注释（和帮助信息，如果有的话）就能够学会如何使用你的程序或库函数，而不需要阅读代码。

所有的函数注释应该包含：

函数的描述

全局变量的使用和修改

使用的参数说明

返回值，而不是上一条命令运行后默认的退出状态

例如：

#!/bin/bash

Perform hot backups of Oracle databases.

export PATH=’/usr/xpg4/bin:/usr/bin:/opt/csw/bin:/opt/goog/bin’

#######################################

Cleanup files from the backup dir

Globals:

BACKUP_DIR

ORACLE_SID

Arguments:

None

Returns:

None

#######################################

cleanup() {

…

}

实现部分的注释

注释你代码中含有技巧、不明显、有趣的或者重要的部分。

这部分遵循谷歌代码注释的通用做法。不要注释所有代码。如果有一个复杂的算法或者你正在做一些与众不同的，放一个简单的注释。

TODO注释

使用TODO注释临时的、短期解决方案的、或者足够好但不够完美的代码。

这与C++指南中的约定相一致。

TODOs应该包含全部大写的字符串TODO，接着是括号中你的用户名。冒号是可选的。最好在TODO条目之后加上 bug或者ticket 的序号。

例如：

TODO(mrmonkey): Handle the unlikely edge cases (bug ####)

格式

---

缩进

缩进两个空格，没有制表符。

在代码块之间请使用空行以提升可读性。缩进为两个空格。无论你做什么，请不要使用制表符。对于已有文件，保持已有的缩进格式。

行的长度和长字符串

行的最大长度为80个字符。

如果你必须写长度超过80个字符的字符串，如果可能的话，尽量使用here document或者嵌入的换行符。长度超过80个字符的文字串且不能被合理地分割，这是正常的。但强烈建议找到一个方法使其变短。

DO use 'here document’s

cat <<END;

I am an exceptionally long

string.

END

Embedded newlines are ok too

long_string="I am an exceptionally

long string."

管道

如果一行容不下整个管道操作，那么请将整个管道操作分割成每行一个管段。

如果一行容得下整个管道操作，那么请将整个管道操作写在同一行。

否则，应该将整个管道操作分割成每行一个管段，管道操作的下一部分应该将管道符放在新行并且缩进2个空格。这适用于使用管道符’|’的合并命令链以及使用’||’和’&&’的逻辑运算链。

All fits on one line

command1 | command2

Long commands

command1 \

| command2 \

| command3 \

| command4

循环

请将 ; do , ; then 和 while , for , if 放在同一行。

shell中的循环略有不同，但是我们遵循跟声明函数时的大括号相同的原则。也就是说， ; do , ; then 应该和 if/for/while 放在同一行。 else 应该单独一行，结束语句应该单独一行并且跟开始语句垂直对齐。

例如：

for dir in ${dirs_to_cleanup}; do

if [[ -d “$dir/${ORACLE_SID}” ]]; then

log_date “Cleaning up old files in $dir/${ORACLE_SID}”

rm “$dir/${ORACLE_SID}/”*

if [[ “$?” -ne 0 ]]; then

error_message

fi

else

mkdir -p “$dir/${ORACLE_SID}”

if [[ “$?” -ne 0 ]]; then

error_message

fi

fi

done

case语句

通过2个空格缩进可选项。

在同一行可选项的模式右圆括号之后和结束符 ;; 之前各需要一个空格。

长可选项或者多命令可选项应该被拆分成多行，模式、操作和结束符 ;; 在不同的行。

匹配表达式比 case 和 esac 缩进一级。多行操作要再缩进一级。一般情况下，不需要引用匹配表达式。模式表达式前面不应该出现左括号。避免使用 ;& 和 ;;&