*******
修訂歷史記錄
目錄1. 目的和範圍 4
1.1. 目的 4
1.2. 範圍 4
2. 術語 4
3. 編碼規範 5
3.1. 命名規範 5
3.1.1. 命名規則 5
3.1.2. 檔案與資料夾命名 5
3.1.3. 物件命名 5
3.1.4. 常量命名 6
3.1.5. 變數命名 6
3.1.6. 例程命名 7
3.1.7. 資料庫物件命名 8
3.2. 結構化**規範 9
3.2.1. **注釋 9
3.2.2. 格式化** 10
3.2.3. 資料庫 11
4. 提示資訊規範 12
4.1. 通用提示 12
4.2. 成本特有的層級日期關聯提示 15
5. 介面規範 15
5.1. 列表相關: 15
5.2. 樹形相關: 16
5.3. 字段相關: 16
5.4. 按鈕相關: 17
5.5. 提示資訊的判斷順序: 17
5.6. 窗體: 18
5.7. 幫助設施: 19
5.8. 選單位置設定 19
5.9. 表單介面 19
5.10. 公用按鈕圖示 19
5.11. 其它: 20
6. 報表製作規範 21
6.1. 報表版面 21
6.1.1. 整體 21
6.1.2. 報表表頭 21
6.1.3. 報表明細 22
6.1.4. 分組、彙總 22
6.2. 報表取數 22
6.3. 其它 22
本文的目的是對編碼進行規範性定義,改善源**的可讀性,提公升產品的可維護性,降低維護成本。
本文詳細描述了軟體開發過程中所有編碼實踐需要遵循的編碼規範。 (注:本部分內容除特殊說明外,都為必須執行。)
◆ 方便**的交流和維護。
◆ 不影響編碼的效率,不與大眾習慣衝突。
◆ 使**更美觀、閱讀更方便。
◆ 使**的邏輯更清晰、更易於理解。
將識別符號的首字母和後面連線的每個單詞的首字母都大寫。可以對三字元或更多字元的識別符號使用pascal 大小寫。
例如:backcolor
適合:屬性或公共變數
識別符號的首字母小寫,而每個後面連線的單詞的首字母都大寫。
例如:backcolor
適合:屬性或公共變數
檔名遵從pascal命名法,無特殊情況,副檔名小寫。
使用統一而又通用的副檔名: c# 類 .cs
每個模組的檔案盡量放在同乙個資料夾下或每個檔案的命名字首為模組名。
在每個檔案頭必須包含以下注釋說明
// copyright (c) 2011 primax it
// 版權所有。
//// 檔名:povendordetail.aspx
// 檔案功能描述:
//用來檢視廠商訂單的明細資料
//// 建立人 :
// 建立日期:2011-10-11
// 修改人 :spark.liang
// 修改時間:2011-10-15
// 修改描述:修改了在firefox下圖層不能顯示的bug
//// 修改人 :xingang.zhang
// 修改時間:2011-10-18
// 修改描述:修改了匯出excel發生亂碼的bug
檔案功能描述只需簡述,具體詳情在類的注釋中描述。
同乙個人一天內有多個修改的只需做乙個在注釋說明中做乙個修改描述就夠了。
在所有的**修改處可加上修改標識的注釋。
**列寬控制在符左右。
當表示式超出或即將超出規定的列寬,遵循以下規則進行換行
1、在逗號後換行。
2、在操作符前換行。
3、規則1優先於規則2。
當以上規則會導致**混亂的時候自己採取更靈活的換行規則。
空行是為了將邏輯上相關聯的**分塊,以便提高**的可閱讀性。
在以下情況下使用兩個空行
1、介面和類的定義之間。
2、列舉和類的定義之間。
3、類與類的定義之間。
在以下情況下使用乙個空行
1、方法與方法、屬性與屬性之間。
2、方法中變數宣告與語句之間。
3、方法與方法之間。
4、方法中不同的邏輯塊之間。
5、方法中的返回語句與其他的語句之間。
6、屬性與方法、屬性與字段、方法與字段之間。
7、注釋與它注釋的語句間不空行,但與其他的語句間空一行。
在以下情況中要使用到空格
1、 關鍵字和左括符 「(」 應該用空格隔開。如
while (true)
注:在vs2008/2010中會**會自動預留空格
注意在方法名和左括符 「(」 之間不要使用空格,這樣有助於辨認**中的方法呼叫與關鍵字。
2、 多個引數用逗號隔開,每個逗號後都應加乙個空格。
3、 除了 . 之外,所有的二元操作符都應用空格與它們的運算元隔開。一元操作符、++及--與運算元間不需要空格。如
a += c + d;
a = (a + b) / (c * d);
while (d++ = s++)
n++;
printsize(「size is 「 + size + 「\n」);
注:在vs2008/2010中**缺省會按以上規則的格式。
4、 語句中的表示式之間用空格隔開。如
for (expr1; expr2; expr3)
1、 左括號「(」 不要緊靠關鍵字,中間用乙個空格隔開。
2、 左括號「(」 與方法名之間不要新增任何空格。
3、 沒有必要的話不要在返回語句中使用()。如
if (condition)
array.remove(1)
return 1
1、 左花括號 「」對齊。
3、 通常情況下左花括號 「,即使{}號中為空或只有一條語句。如
if (somevalue == 1)
軟體專案開發工作說明書V1
系統 工作說明書 xx 2010年 月 本工作說明書系xx 以下簡稱 乙方 為公司 以下簡稱 甲方 承擔的系統 以下簡稱 本專案 提供服務的說明。專案組織由以下各方人員組成 甲方 專案經理 業務人員 it人員。乙方 專案經理 專案開發和技術支援人員。在本專案中,雙方之基本權利和基本義務說明如下。1 ...
APP開發規範 APP介面開發規檔V1
手機客戶端介面文件 版本歷史 目錄一 概述 1 1.1 有關介面 1 1.1.1介面是純資料的互動 1 1.2 介面的分類 1 1.2.1查詢類介面 1 1.2.2 操作類介面 1 1.2.3上傳 類介面 1 1.2.4推送類介面 1 二 查詢類介面格式規範 1 2.1獲取單條物件資訊 1 2.1....
硬體開發流程 V1
品牌硬體部 檔案修改記錄 目錄1.目的 4 2.適用範圍 4 3.硬體工程師職責 4 4.硬體各開發階段流程 5 4.1 evt階段開發流程 5 4.2 dvt pvt階段開發流程 6 5 文件 資料歸檔和審查 7 1.目的 硬體開發流程是指導硬體工程師設計規範化的準則,規範了硬體開發的全過程。對硬...