團隊-象棋遊戲-代碼設計規範
逆流而上
象棋遊戲 代碼規範
一、前言:
本編程規範適用於編寫HTML/CSS代碼,本規範並不是一個一成不變的必須嚴格遵守的條文,特殊情況下應靈活應對,做到變通。
二、HTML編碼:
HTML是一種標記語言,HTML沒有任何真正的編程語言中的循環或是流程控制語句。然而,HTML代碼的格式和風格是非常重要的,因為要經常對HTML代碼進行維護和修改,因此HTML代碼必須有很清晰的邏輯結構和布局,增強可讀性,而使其易懂和易於維護。HTML代碼本身是不區分大小寫的,但是為了更好的統一代碼布局,本項目中HTML文件標記都以小寫為主。
三、軟件:
編碼同一使用HBuilder軟件;瀏覽器統一使用最新版
四、標記規範:
1.標記應對應編碼,不可出現交叉編碼,例:<p><font>內容</p></font>;
2.開始和關閉標記放在同一行內;
3.因不涉及聯網,HTML文件頭基本標記為:<!DOCTYPE html>;
4.對於標記內的屬性,務必使用雙引號包圍;
5.對於img圖片標簽,務必在屬性欄中添加alt=“圖片描述文字”;
五、標記的縮進規範:
1.最高一級父標記采用左對齊頂個方式書寫;
2.下一級標記采用左對齊後,縮進一個Tab鍵的方式來縮寫,再下一級以此類推;
3.同一級標記的首字符上下應對齊;
六、HTML文件引入CSS樣式代碼和JavaScript代碼規範:
CSS樣式代碼引入:<link rel="stylesheet" type="text/css" href="引入文件名.css" />;
JavaScript代碼引入:<script type="text/javascript" src="引入文件名.js"></script>;
七、HTML註釋標簽:
在每個功能塊前添加註釋標簽以方便閱讀編碼含義;<!--註釋內容-->;
八、CSS編碼要求:
所有代碼以小寫字母的形式編寫;樣式代碼采用一種樣式占一行並使用Tab鍵縮進,例如: width:
九、CSS樣式表規範:
Id和class命名采用該版塊的英文單詞或組合命名,每個單詞都用小寫,用下劃線連接起來,例如:content_main(主要內容區);
十、樣式文件命名:
chess_c.css
主要功能:chess_main.js
開始遊戲:chess_start.js
重置遊戲:chess_reset.js
悔棋和撤銷悔棋:chess_regret.js
人機對戰:chess_ai.js(待定)
團隊-象棋遊戲-代碼設計規範