MiniSNS-代碼規範

JS代碼規範
1註釋
代碼註釋需要說明“函數功能”、“入口參數”、“返回值”

2 類型、字段、屬性、方法、事件的命名

統一使用英文。如果實在找不到合適描述可以使用中文但必須是全拼。使用中文是不符合要求的。
命名規範統一使用駝峯法(函數名中的每一個邏輯斷點都有一個大寫字母來標記)。並且所有類型、方法、參數、變量的命名不得使用縮寫,包括大家熟知的縮寫,例如msg。
3、 使用Tab作爲縮進,並設置縮進大小爲4
4、 如果if語句內容只有一行,可以不加花括號,但是必須和if語句位於同一行
5、前綴規範:
每個局部變量都需要有一個類型前綴,按照類型可以分爲:

s:表示字符串。例如:sName,sHtml;
n:表示數字。例如:nPage,nTotal;
b:表示邏輯。例如:bChecked,bHasLogin;
a:表示數組。例如:aList,aGroup;
r:表示正則表達式。例如:rDomain,rEmail;
f:表示函數。例如:fGetHtml,fInit;
o:表示以上未涉及到的其他對象,例如:oButton,oDate;
g:表示全局變量,例如:gUserName,gLoginTime

CSS 代碼風格要求

1、避免重複定義

重複的屬性儘可能避免重複定義,而需要分組定義元素的屬性。如果您的h1和h2元素都是使用相同的字體大小、顏色、和邊框等,他們完全和可以合併成組定義。
2、 使用Tab作爲縮進,並設置縮進大小爲4
3、 結構、樣式、行爲分離
儘量確保文檔和模板只包含 HTML 結構,樣式都放到樣式表裏,行爲都放到腳本里。
4、Class 和 ID
使用語義化、通用的命名方式;
使用連字符 - 作爲 ID、Class 名稱界定符,不要駝峯命名法和下劃線;
避免選擇器嵌套層級過多,儘量少於 3 級;
避免選擇器和 Class、ID 疊加使用;
出於性能考量,在沒有必要的情況下避免元素選擇器疊加 Class、ID 使用。
元素選擇器和 ID、Class 混合使用也違反關注分離原則。如果 HTML 標籤修改了,就要再去修改 CSS 代碼,不利於後期維護。
5、媒體查詢(Media query)的位置
將媒體查詢放在儘可能相關規則的附近。不要將他們打包放在一個單一樣式文件中或者放在文檔底部。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章