頂部新增檔案申明資訊,包括檔案描述、原始作者,如果有更新,則需要新增更新內容、更新作者和更新時間。
/** * @description: 說明文字
* @author: 張三 */
/*** @description: 說明文字
* @author: 張三
* @update: 更新內容 by 李四 2013-04-13 18:32
*/
無論是單行注釋還是多行注釋,注釋中的每一行長度都不能超過40個漢字,或者80個英文本元。
單行注釋
/*this is a short comment
*/
多行注釋
/** this is comment line 1.
* this is comment line 2.
*/
/** * 這是乙個求和函式
* @param a 第乙個數字
* @param b 第二個數字
* @return 返回兩個數字之和 */
var sum = function
(a, b)
模組注釋必須單獨寫在一行。
/*模組:****** by 張三
*/...
/*模組:****** by 張三
*/
/*header
*/...
/*footer
*/...
/*banner
*/...
編碼規範 注釋
1 源程式注釋量需要達到 總量的20 以上。2 為類編寫詳細的說明性檔案,格式如下 author lian lekai version 1.0.1 date 2015 01 21 description 後台管理系統主檔案,主要作用是 others function list 1 註冊 2 登入 3...
前端編碼規範
從一篇文章上 前端編碼規範 摘取了自己還沒形成習慣的點 好的規範寫法 html語法 1.用兩個空格來代表製表符 tab 這是唯一能保證在所有 環境下獲得一致展現的方法 2.對於屬性的定義,確保全部使用雙引號,絕不要使用單引號 3.不要在自閉合元素的尾部新增斜線 屬性順序 html屬性應當按照以下給出...
前端開發規範之html編碼規範
原則 1.規範 保證您的 規範,趨html5,遠xhtml,保證結構表現行為相互分離。2.簡潔。保證 的最簡化,避免多餘的空格 空行,保持 的語義化,盡量使用具有語義的元素,避免使用樣式屬性和行為屬性。任何時候都要用盡量簡單 盡量少的元素解決問題。3.實用。遵循標準,但是不能以犧牲實用性為代價。4....