團隊編碼規范

HTML編碼規范

1、代碼風格

• 1.1 縮進與換行
  使用 4 個空格做為一個縮進層級，不允許使用 2 個空格 或 tab 字符。
  注：每行不得超過 120 個字符。（過長的代碼不容易閱讀與維護。）
• 1.2 命名
  （1）class 必須單詞全字母小寫，單詞間以 - 分隔。
  （2）class 必須代表相應模塊或部件的內容或功能，不得以樣式信息進行命名。
  （3）元素 id 必須保證頁面唯一。（同一個頁面中，不同的元素包含相同的 id，不符合 id 的屬性含義。）
  （4）id 建議單詞全字母小寫，單詞間以 - 分隔。同項目必須保持風格一致。
  （5）id、class 命名，在避免沖突并描述清楚的前提下盡可能短。
  （6）同一頁面，應避免使用相同的 name 與 id。（IE 瀏覽器會混淆元素的 id 和 name 屬性）
• 1.3 標簽
  （1）標簽名必須使用小寫字母。
  （2）對于無需自閉合的標簽，不允許自閉合。
  （3）對 HTML5 中規定允許省略的閉合標簽，不允許省略閉合標簽。
  （4）標簽使用必須符合標簽嵌套規則。
  （5）HTML 標簽的使用應該遵循標簽的語義。
  （6）在 CSS 可以實現相同需求的情況下不得使用表格進行布局。
  （7）標簽的使用應盡量簡潔，減少不必要的標簽。
• 1.4常見標簽語義：
  p - 段落
  h1,h2,h3,h4,h5,h6 - 層級標題
  strong,em - 強調
  ins - 插入
  del - 刪除
  abbr - 縮寫
  code - 代碼標識
  cite - 引述來源作品的標題
  q - 引用
  blockquote - 一段或長篇引用
  ul - 無序列表
  ol - 有序列表
  dl,dt,dd - 定義列表
• 1.5屬性
  （1）屬性名必須使用小寫字母。
  （2）屬性值必須用雙引號包圍，不允許使用單引號，引號。
  （3）布爾類型的屬性，建議不添加屬性值。
  （4）自定義屬性建議以 xxx- 為前綴，推薦使用 data-。

2、Head

• 2.1 title
  （1）頁面必須包含 title 標簽聲明標題。
  （2）title 必須作為 head 的直接子元素，并緊隨 聲明之后。

3、圖片

• （1）禁止 img 的 src 取值為空。延遲加載的圖片也要增加默認的 src。
• （2）避免為 img 添加不必要的 title 屬性。
• （3）為重要圖片添加 alt 屬性。
• （4）添加 width 和 height 屬性，以避免頁面抖動。

4、表單

• 4.1文本
  （1）有文本標題的控件必須使用 label 標簽將其與其標題相關聯。
• 4.2按鈕
  （1）使用 button 元素時必須指明 type 屬性值。
  （2）盡量不要使用按鈕類元素的 name 屬性。
• 4.3可訪問性
  （1）當使用 JavaScript 進行表單提交時，如果條件允許，應使原生提交功能正常工作。
  （2）在針對移動設備開發的頁面時，根據內容類型指定輸入框的 type 屬性。
  （3）負責主要功能的按鈕在 DOM 中的順序應靠前。

JavaScript編碼規范

1、行長度

• 每行代碼應小于 80 個字符。如果代碼較長，應盡量選擇換行，下一行代碼應縮進 8 個空格。這樣可以使代碼排版整齊，減輕閱讀代碼的疲勞感。換行縮進 8 個空格可以和代碼段的縮進 4 個空格區分開，以增強代碼的可閱讀性。

2、行結束

• JavaScript 語句應該以分號結束。但大多數瀏覽器允許不寫分號，只要在本應是分號的地方有一個換行符就行。但是如果代碼行較長需要換行的時候，有哪些注意事項呢？換行應選擇在操作符和標點符號之后，最好是在逗號','之后，而不要在變量名、字符串、數字、或')' ']' '++' '--'等符號之后換行。這樣可以有效的防止拷貝、粘貼而引起的錯誤，并可有效地增強代碼的可閱讀性。請見清單 1，代碼的輸出符合我們的期望。但就寫法而言，對 valueB 的賦值語句是在變量 valueA 之后進行的換行，這很容易被誤解為 valueB=ValueA，給閱讀造成障礙。而對 valueC 的復制語句是在'+'之后進行的換行，就容易理解的多。這也是本文所提倡的換行方式。但就寫法而言，對 valueB 的賦值語句是在變量 valueA 之后進行的換行，這很容易被誤解為 valueB=ValueA，給閱讀造成障礙。而對 valueC 的復制語句是在'+'之后進行的換行，就容易理解的多。這也是本文所提倡的換行方式。

3、縮進

• 關于縮進的問題，不只是 JavaScript，幾乎所有的語言編寫的時候，都會提及縮進的問題。縮進幾乎是代碼編寫規范的第一課，是代碼可閱讀性判斷的直接因素。
• 代碼縮進的好處是不言而喻的，但是對于如何縮進，則沒有標準而言。最受歡迎的是方便使用 TAB 鍵縮進，也有些喜歡用 2 個、4 個、8 個空格進行縮進。這樣縮進風格不一，也同樣給代碼的閱讀帶來障礙。

4、注釋

• 代碼中的注釋很重要，自然也是毋庸置疑的。通常我們會強調代碼中注釋數量的多少，而輕視了對注釋質量的提高。編碼是及時添加注釋，會給后續代碼的維護人員帶來很大的便利。但是如果注釋不注意更新，或者由于拷貝、粘貼引起的錯誤的注釋，則會誤導閱讀人員，反而給閱讀帶來障礙。

5、空白符

• 適當的空白行可以大大提高代碼的可閱讀性，可以使代碼邏輯更清晰易懂。同時，在表達式中適當的留空白，也會給代碼的閱讀帶來方便。
• 關鍵字的后面如有括號，則最好在關鍵字和左括號'('之間留空白，如 for, if, while 等。而函數名和括號之間則不宜留空白，但若是匿名函數，則必須在 function 和左括號'('之間留空白，否則，編輯器會誤認為函數名function。
• 在表達式中，二元運算符 ( 除左括號'('，左方括號'['，作用域點'.') 和兩個操作數之間最好留空白。一元運算符（若不是詞 typeof 等）和其操作數之間不宜留空白。
• 逗號','的后面需要留空白，以顯示明確的參數間隔，變量間隔等。
• 分號';'之后通常表明表達語句的結束，而應空行。在 for 的條件語句中，分號之后則應該留空白。

6、括號{ } 和 [ ]

• 在 JavaScript 中，如需定義空對象和空數組，通常很自然地想到用 new Object() 和 new Array() 的方法。其實花括號'{}'和方括號'[]'可以直接用來定義一個空對象和一個空數組。這種書寫方法可以使代碼看起來簡單易懂。

7、標識符命名

• 以字母、下劃線'_'或美元符號'$'開頭
• 允許名稱中包含字母，數字，下劃線'_'和美元符號'$'
• 區分大小寫
• 變量、參數、成員變量、函數等名稱均以小寫字母開頭，構造器的名稱以大寫字母開頭。 下劃線''開頭的變量一般習慣于標識私有/局部成員。而美元符號'$'開頭的變量習慣于標識系統相關，比如系統進程等。應避免用下劃線''或美元符號'$'來命名標識符。盡可能地降低代碼的閱讀負擔。

8、變量的聲明

• 盡管JavaScript語言并不要求在變量使用前先對變量進行聲明。但我們還是應該養成這個好習慣。這樣可以比較容易的檢測出那些未經聲明的變量，避免其變為隱藏的全局變量，造成隱患。 在函數的開始應先用var關鍵字聲明函數中要使用的局部變量，注釋變量的功能及代表的含義，且應以字母順序排序。每個變量單獨占一行，以便添加注釋。這是因為JavaScript中只有函數的{}表明作用域，用var關鍵字聲明的局部變量只在函數內有效，而未經var聲明的變量則被視為全局變量。

Android編碼規范

1、通用格式

• (1) 文件編碼格式為 UTF-8.
• (2) 文件換行為 Unix 格式( ‘\n’ ).
• (3) 同方法內, 以空行區分不同的邏輯塊.
• (4) 命名中只能用英文單詞, 不可出現拼音.
• (5) 一個方法不要超過2屏(約80 ~ 100行), 超過時考慮按邏輯封裝為更小的方法.
• (6) 代碼中(包括源碼文件和布局文件)除注釋外, 不可出現中文. 需要中文時提取為資源文件再進行引用. 原則上中文只應出現在 string.xml 中.
• (7) 每個類和功能性 public 的方法需要注釋, 參考 javadoc 的寫法. private 方法若復用性較高也須注釋.
• (8) 修改代碼時, 也須修改相應文檔.
• (9) 每個 Java 文件只含一個類. 如果只在當前類中引用的接口( Interface ), 可以放在同一個 java 文件中, 其余情況下,接口均應放到獨立的 java 文件中.
  定義局部變量時, 必須初始化.
• (10) 全局變量在類中聲明并初始化時, 只可賦值為 null 或空值, 不可直接 new 對象進行賦值.
• (11) 對于 if, while, for 等邏輯塊, 總是使用花括號括起每一個分支. 即使分支中只有一行 return 也須用花括號括起.
• (12) switch 結構中, 如果需要 fall through 時, 需要在相應的 case 中做注釋.
  提交代碼時勾選 Before Commit 中的 Reformat code, Rearrange code, Optimize imports 三個選項.

2、命名規范

• 2.1大小寫規范.
  (1)類以大寫字母為開頭.
  (2)常量全為大寫字母, 單詞間以下劃線進行分隔.
  (3)其余均為首字母小寫, 每個單詞首字母大寫.
  (4)使用縮略詞時, 將其當作一個單詞. 如 getUrl, 而非 getURL.
• 2.2名稱規范
  (1)靜態變量, 開頭為 s
  (2)非靜態的私有變量, protected 的變量, 開頭為 m
  (3)ListView 等控件, 填充成員的類命名, 必須以 Item 開頭
• 2.3非ASCII字符
  對于剩余的非ASCII字符，是使用實際的Unicode字符(比如∞)，還是使用等價的Unicode轉義符(比如\u221e)，取決于哪個能讓代碼更易于閱讀和理解。
  Tip:在使用Unicode轉義符或是一些實際的Unicode字符時，建議做些注釋給出解釋，這有助于別人閱讀和理解。
• 例如：
  String unitAbbrev = "μs"; | 贊，即使沒有注釋也非常清晰
  String unitAbbrev = "\u03bcs"; // "μs" | 允許，但沒有理由要這樣做
  String unitAbbrev = "\u03bcs"; // Greek letter mu, "s" | 允許，但這樣做顯得笨拙還容易出錯
  String unitAbbrev = "\u03bcs"; | 很糟，讀者根本看不出這是什么
  return '\ufeff' + content; // byte order mark | Good，對于非打印字符，使用轉義，并在必要時寫上注釋
  Tip:永遠不要由于害怕某些程序可能無法正確處理非ASCII字符而讓你的代碼可讀性變差。當程序無法正確處理非ASCII字符時，它自然無法正確運行， 你就會去fix這些問題的了。(言下之意就是大膽去用非ASCII字符，如果真的有需要的話)

數據庫設計

• 教師
  
• 學生
  
• 學生信息
  
• 管理員
  

• 數據庫注釋
  student：學生
  Account No：賬號
  Password：密碼
  Student Information：學生信息
  name:姓名
  age:年齡
  sex：性別
  nation：民族
  faculty：學院
  major：專業
  class：班級
  Phonenumber：電話號碼
  Student ID：學號
  Dormitory No：宿舍樓號
  Bedroom No:宿舍號
  ID card No：身份證號
  Manager：管理員
  Teacher：老師

ER圖

主要功能流程描述

• 登錄
  

• 寢室分配
  

• 信息查詢
  

• 修改信息
  

作業分工

• 吳香南 1500802037 工作：分配工作、畫ER圖、流程圖功能描述、發布博客
• 張永婷 1500802004 工作：編寫編碼規范、畫主要功能流程圖查詢信息部分
• 呂占英 1500802034 工作：編寫編碼規范、畫主要功能流程圖查詢部分
• 劉盈秀 1500802015 工作：編寫數據庫設計、畫主要功能流程圖分配寢室部分
• 岳錦霞 1500802001 工作：編寫數據庫設計、畫主要功能流程圖修改信息、登錄部分

組員貢獻分

• 吳香南 1500802037 （10分）
• 張永婷 1500802004 （10分）
• 呂占英 1500802034 （10分）
• 劉盈秀 1500802015 （10分）
• 岳錦霞 1500802001 （10分）

轉載于:https://www.cnblogs.com/wxn-151/p/6925918.html

與50位技術專家面對面20年技術見證，附贈技術全景圖

總結

以上是生活随笔為你收集整理的软件工程——团队作业3的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。