shell編程規(guī)范

1、shell編程規(guī)范第1頁Shell編程規(guī)范編程規(guī)范v1.0.020190829目錄一、一、命名規(guī)范命名規(guī)范.....................................................................................................................21、版本和運(yùn)行參數(shù)版本和運(yùn)行參數(shù).................................

2、....................................................................22、變量命名變量命名.................................................................................................................23、函數(shù)命名函數(shù)命名.................

3、................................................................................................34、腳本腳本(模塊模塊)命名命名.....................................................................................................35、臨時(shí)文

4、件的命名臨時(shí)文件的命名.....................................................................................................3二、二、代碼風(fēng)格代碼風(fēng)格...............................................................................................

5、......................41、代碼框架代碼框架.................................................................................................................42、函數(shù)函數(shù)...................................................................

6、......................................................43、條件語句與循環(huán)條件語句與循環(huán).....................................................................................................44、縮進(jìn)縮進(jìn).........................................

7、................................................................................5三、三、注釋規(guī)范注釋規(guī)范.....................................................................................................................51、文件文件模塊說

8、明模塊說明.......................................................................................................52、重要函數(shù)說明重要函數(shù)說明.................................................................................................

9、........63、其它其它.........................................................................................................................6四、四、日志規(guī)范日志規(guī)范.......................................................................

10、..............................................6五、五、接口文件規(guī)范接口文件規(guī)范.............................................................................................................7六、六、配置規(guī)范配置規(guī)范...................................

11、..................................................................................71、配置文件配置文件.................................................................................................................72、配置項(xiàng)的檢查配置項(xiàng)的檢

12、查.........................................................................................................8七、七、報(bào)警規(guī)范報(bào)警規(guī)范.....................................................................................................

13、................8八、八、其它細(xì)節(jié)其它細(xì)節(jié).....................................................................................................................8九、線上實(shí)例補(bǔ)充九、線上實(shí)例補(bǔ)充.........................................................

14、..........................................................10shell編程規(guī)范第3頁dodosomethingdone4)變量合并：當(dāng)某些變量或配置項(xiàng)要組合起來才有意義時(shí)，如文件的路徑和文件名稱，建議將要組合的變量合并到一起賦值給一個(gè)新的變量，這樣既方便之后的調(diào)用，也為以后進(jìn)行修改提供了方便。3、函數(shù)命名函數(shù)命名1)函數(shù)命名使用單詞首字母大寫，如CreateFile，并且要語義

15、清晰，如使DumpDataToFile()代替DataFile()。同時(shí)要注意前后綴，如后綴為Max則為最大值，Min為最小值，前綴Is為判斷型函數(shù)，Get則為取值函數(shù)，這樣有益于對(duì)函數(shù)的返回理解更清晰。2)注意在使用單詞縮寫時(shí)，也使用首字母大寫，如GetHtmlContent而并非GetHTMLContent，這樣有利于命名規(guī)則的統(tǒng)一。4、腳本腳本(模塊模塊)命名命名1)Shell腳本使用統(tǒng)一后綴：.sh2)所有模塊的啟動(dòng)和停止腳本必

16、須統(tǒng)一命名為start_模塊名.sh和stop_模塊名.sh3)模塊(及其腳本和二進(jìn)制程序)命名應(yīng)該代表其特性和功能，禁止使用個(gè)人名字縮寫等形式命名。4)模塊中的腳本和二進(jìn)制程序命名禁止和其他腳本和二進(jìn)制程序重名。5、臨時(shí)文件的命名臨時(shí)文件的命名盡量避免臨時(shí)文件，如果一定要使用臨時(shí)文件，請(qǐng)使用腳本的pid作為后綴，并在腳本結(jié)束時(shí)清除臨時(shí)文件。例如：PID=$$TMP_FILE=”tmp_keywds.”$PIDgrepkeywdsfil