1 排版
1-1:程序塊要采用縮進(jìn)風(fēng)格編寫,縮進(jìn)的空格數(shù)為4個(gè)。
1-2:相對獨(dú)立的程序塊之間和相對獨(dú)立的變量定義之后必須加空行。
1-3:較長的語句(>80字符)要分成多行書寫,長表達(dá)式要在低優(yōu)先級操作符處劃分新行,操作符放在新行之首,劃分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn),使排版整齊,語句可讀。
1-4:循環(huán)、判斷等語句中若有較長的表達(dá)式或語句,則要進(jìn)行適應(yīng)的劃分,長表達(dá)式要在低優(yōu)先級操作符處劃分新行,操作符放在新行之首。
1-5:若函數(shù)或過程中的參數(shù)較長,則要進(jìn)行適當(dāng)?shù)膭澐帧?/P>
1-6:在兩個(gè)以上的關(guān)鍵字、變量、常量進(jìn)行對等操作時(shí),它們之間的操作符之前、之后或者前后要加空格;進(jìn)行非對等操作時(shí),如果是關(guān)系密切的立即操作符(如.->::),后不應(yīng)加空格。
1-7:一行程序以小于80字符為宜,不要寫得過長。
2 注釋
2-1:一般情況下,源程序有效注釋量必須在20%以上。
2-2:源代碼應(yīng)在開始處進(jìn)行注釋,注釋應(yīng)列出:版權(quán)說明、版本號、生成日期、作者、模塊目的/功能、主要函數(shù)及其功能、修改日志、調(diào)用示例等。
2-3:事件、方法、過程的代碼應(yīng)在開始處進(jìn)行注釋,注釋應(yīng)列出:版權(quán)說明、版本號、生成日期、作者、模塊目的/功能、修改日志、調(diào)用示例等。
2-4:過程的頭部應(yīng)進(jìn)行注釋,列出:函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用示例等。
2-5:邊寫代碼邊注釋,修改代碼同時(shí)修改相應(yīng)的注釋,以保證注釋與代碼的一致性。不再有用的注釋要?jiǎng)h除。
2-6:注釋的內(nèi)容要清楚、明了,含義準(zhǔn)確,防止注釋二義性。
2-7:避免在注釋中使用縮寫,特別是非常用縮寫。
2-8:注釋應(yīng)與其描述的代碼相近,對代碼的注釋應(yīng)放在其上方或右方(對單條語句的注釋)相鄰位置,不可放在下面,如放于上方則需與其上面的代碼用空行隔開。
2-9:對于所有有物理含義的變量、常量,如果其命名不是充分自注釋的,在定義時(shí)都必須加以注釋,說明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。
2-10:全局變量要有較詳細(xì)的注釋,包括對其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時(shí)注意事項(xiàng)等的說明。
2-11:注釋與所描述內(nèi)容進(jìn)行同樣的縮排。
2-12:將注釋與其上面的代碼用空行隔開。
2-13:對變量的定義和分支語句(條件分支、循環(huán)語句等)必須編寫注釋。
2-14:通過對函數(shù)或過程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu),使代碼成為自注釋的。
2-15:在代碼的功能、意圖層次上進(jìn)行注釋,提供有用、額外的信息。
2-16:在程序塊的結(jié)束行右方加注釋標(biāo)記,以表明某程序塊的結(jié)束。
2-17:注釋格式盡量統(tǒng)一,建議使用“*--”和“&&--”。
2-18:注釋應(yīng)考慮程序易讀及外觀排版的因素,使用的語言若是中、英兼有的,建議多使用中文,除非能用非常流利準(zhǔn)確的英文表達(dá)。
參考資料:華為軟件編程規(guī)范
*-- 群:VFP軟件開發(fā)(55569163)