SHELL程序编码规范培训.ppt

SHELL编码规范培训教材 xxxx信息技术股份有限公司 2007年08月 内容简介 程序排版 程序注释 命名规范 程序块和函数 部署规划 可读性 安全要求 2 程序排版 规则2.1 程序注释放在程序最开始位置 规则2.2 shell指定说明 规则2.3 全局变量定义每个变量占用一行 规则2.4 全局函数与全局变量之前空一行 规则2.5 函数之间用一行空行间隔 规则2.6 函数注释放在函数前一行 规则2.7 函数中的每个变量定义占用一行 规则2.8 函数中变量定义放在函数体最前面 规则2.9 shell程序主体与最后一个函数之间空一行 规则2.10 程序块注释放在程序块前一行 规则2.11 程序块间使用一行空行间隔 规则2.12 程序逻辑缩进同一采用4个空格 规则2.13 if语句的关键字if,then,fi独立占用一行,且竖向对齐 规则2.14 while循环语句的关键字while,do,done独立占用一行，且竖向对齐 规则 2.15 util循环语句的关键字util,done独立占用一行，且竖向对齐 规则 2.16 for循环语句的关键字for,do,done独立占用一行，且竖向对齐 规则 2.17 break和continue语句独立占用一行 3 程序注释 规则3.1 所有注释均使用#开头 规则3.2 程序注释的每个信息占用一行 规则3.3 如果shell进行了修改，必须注释修改的日期，修 改人，修改说明 规则3.4 全局变量的注释放在变量的前一行 规则3.5 函数注释的每个信息占用一行 规则3.6 函数注释位于函数定义前一行 规则3.7 用中文写出每个函数的参数的含义 规则3.8 函数中定义的变量注释放在变量之前 规则3.9 注释与所描述的代码具有同样的缩进格式 4 命名规范 规则4.1 shell文件名是英文名称，不能使用汉语拼音 规则4.2 文件名采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写 规则4.3 函数名是动词+名词对 规则4.4 函数名采用大小写混合的方式，第一个单词的首字母下写，其后单词的首字母大写 规则4.5 不能使用单个字符的变量名 规则4.6 参数的命名和变量的命名一致 建议4.7 文件名应该准确描述shell程序的功能，不要使用无意义或含义不清的英文单词 建议4.8 函数名应该准确描述函数的功能 建议4.9 变量定义全部使用大写 5 命名规范 规则5.1 程序块前的注释要描述清楚程序块实现的功能 建议5.2 函数规模限制在50-100行，逻辑过于复杂，需要剥离出独立的函数 建议5.3 一个函数仅完成一个功能 建议5.4 不要设计过多参数函数，去掉不使用的参数 建议5.5 减少函数的递归调用 6 命名规范 shell程序的部署强制要求如下：系统相关的所有shell程序存放在$HOME/shell目录下。 建议6.1 为了安全起见，shell程序的文件权限限制为600，有特殊要求的可以授予其他的权限。 7 可读性 规则7.1 不能在一行代码或者表达式的中间插入注释 建议7.2 注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达 建议7.3 通过对函数、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的 8 安全要求 规则8.1 不允许使用shell程序实现数据库相关处理 规则8.2 不允许使用shell程序实现FTP连接相关处理 * * 如下的示例是不允许的使用方式： sqlplus $USER/$PASSWD@mydb ! select ****,BUSINESS_ID from business_relation where BUSINESS_TRUE_ID=$var1 and rownum=1; exit ! 如下的示例是不允许的使用方式： ftp -n $IP! user $USER $PASSWD cd clubUserInfo bi promp mget *_memuserinfo_*_0*.txt bye ! * * * 首页面