ApeML代碼書寫規(guī)范

shelia 2006-02-20

展開全文

ApeML代碼書寫規(guī)范修訂版適用模擬精靈2005 v4.50 以上版本 1.必須區(qū)分大小寫無論在模擬精靈的任何地方書寫代碼或者調(diào)整參數(shù)，必須區(qū)分大小寫。 2.標識符第一個字符必須是字母或者下劃線所有標識符(變量名字、函數(shù)名、ApeML節(jié)點名字)第一個字符必須是字母或者下劃線（也就是說不能是數(shù)字），如果標識符由多個單詞組成，除第一個單詞小寫以外，其他的單詞第一個字母大寫。全局變量以下劃線作為第一個字符，普通變量第一個字符小寫全局常量以下劃線開始并全部大寫，普通常量大寫。函數(shù)名第一個字符小寫，用戶自定義函數(shù)名第一個字符不能為下劃線（第一個字符為下劃線的函數(shù)為系統(tǒng)內(nèi)置函數(shù)) 3.變量名盡可能的用簡潔清晰的命名所有變量名盡可能的用簡潔清晰的命名，簡潔指的是可以縮寫的單詞使用最短的縮寫，清晰指的是可以考慮用多個單詞清晰的表達變量的意義 4.優(yōu)先使用標準變量名在沒有變量名沖突的情況下，應優(yōu)先選用標準變量名。模塊對象，標準變量名使用 m,m2等 image對象, 標準變量名使用 img,img2等 color對象，標準變量名使用 cl,cl2等 web對象，標準變量名使用 wb,wb2等循環(huán)、迭代、索引等標準變量名使用 i,j等 5.正確的代碼分行不要在一行寫太長的代碼。適當?shù)氖褂脫Q行符號(分號; 可以忽略) LAScript中，不允許連續(xù)的寫兩個換行符號，如：;; 兩個分號寫在一起，在其他編程語言中是正確的，可是在LAScript中是錯誤的 6.回調(diào)函數(shù)以LAScript:作為開始標記（可以忽略) 如：失敗="LAScript:return _CMD_LOOP " 7.合理的使用括號、空格一、合理使用括號在算術(shù)運行中必要的時候應當使用括號表示運算的先后順序，如果多層嵌套括號最外層括號應間隔兩個空格如 a + b + c * 2 + 1這樣的代碼是不被推薦的，你應當用括號顯示的表示運算的先后順序; 如( (a + b) + (c * 2) ) + 1; 下面的代碼是不被推薦的 if a == 1 then a = 2; end; 標準的格式應當加上括號寫成這樣： if( a == 1)then a = 2; end; 二、合理使用空格普通的操作符與變量應當用空格分開. 括號前面以及后面的空格可酌情省略，如果有多層括號嵌套，外層括號包含的空格數(shù)應大于內(nèi)層括號的空格數(shù)以表示層次通常，最外層括號內(nèi)側(cè)應包含兩個空格，最外層括號外側(cè)不包含空格，最內(nèi)層括號內(nèi)側(cè)不包含空格例如 if (( a==b )and(b==c)) then b=1+2 end; 這樣的書寫格式是不被推薦的。錯誤一：a==b 操作符==與變量a、b沒有用空格分開,應當寫成 a == b 錯誤二: ( a==b ) 最內(nèi)層括號內(nèi)側(cè)不應當包含空格，應當寫成 (a == b) 錯誤三：最外層括號內(nèi)側(cè)應當包含兩個空間，外側(cè)不應當有空格，正確的寫法應當是: if( (a == b) and (b == c) )then b = 1 + 2; end; 8.代碼格式應正確反映邏輯結(jié)構(gòu)和嵌套標準嵌套塊應縮進一個tab鍵(在模擬精靈中不允許使用四個空格鍵縮進) 在網(wǎng)頁或其他地方發(fā)布源代碼、文檔等，應當重新處理源代碼用四個空格鍵替換tab鍵(因為每個程序顯示tab鍵的風格都不相同) ApeML腳本區(qū)塊的第三行(即 <![CDATA[ 后面的第一行) 不允許縮進嵌套層次不要過多(正常情況下不要常過三層) 9.加上local關(guān)鍵字聲明變量時推薦如無特別需要應加上local關(guān)鍵字聲明為局部變量。如： a = 10; --不被推薦的寫法 local a = 10 --推薦的寫法如果要聲明全局變量，應在前面加上下劃線以示區(qū)別如 a =10 ; --不被推薦的聲明全局變量方法 _a =10 ; --推薦的聲明全局變量的寫法，應在前面加上下劃局部變量會提前釋放內(nèi)存，并且可以防止函數(shù)中的變量名與全局變量名相同導致的沖突。 10.注釋為代碼書寫簡潔清晰的注釋。例如: --函數(shù)功能:掃描屏幕參數(shù)(信息,標題="",樣式=0) win.messageBox = function(msg,title,style) --函數(shù)代碼 end; 函數(shù)必須添加注釋，注釋應按照上面演示的格式，可選參數(shù)在=號后面說明默認值