軟件開發規范（2）

2019-11-18 13:45:33

字體：大中小

來源：轉載

供稿：網友

　　軟件開發規范（2）

4.4 數據庫命名規范
數據庫表命名均遵循以下規范：
模塊名_存儲信息名詞(多個單詞用下劃線分隔)，全部小寫，例如：ebwebmail_message。

數據庫字段命名遵循以下規范：
存儲信息名詞(多個單詞用下劃線分隔)，全部小寫，例如：message_id。

5 文檔規范
1. 編寫文檔目前主要使用的工具是Word（項目計劃文檔例外，需要使用PRoject制作），輔助使用的工具有Visio，Powerpoint，ERWin等。

2. 文檔務必保持段落格式整潔，文字字體，顏色，大小統一。

3. 假如需要摘引Html頁面中的內容，不能直接從html中粘貼過來（會在word文檔中留下html格式），而必須先去除格式，例如：先粘貼到notepad中。

4. 務必注重中英文標點符號，文檔正文一概使用中文標點符號。

5. 假如需要在文檔中插圖，不要使用word自帶的繪圖工具。可以選擇使用PowerPoint或visio。使用PowerPoint，選擇“插入”->“對象”->“Microsoft PowerPoint 幻燈片”。使用visio，需要另外建立visio文檔，繪制完以后粘貼到word中。

6. 數據建模使用ERwin工具，文檔中僅需要粘貼數據模型的邏輯視圖（logical view），另外還要附上表結構描述。

7. 修改他人文檔務必使用修訂模式，以便保留備修改的內容。使用修訂模式，選擇“工具”->“修訂”->“突出顯示修訂”，勾上“編輯時標記修訂”。

附：一些模版
ü java類設計(class documentation)
聲明：

描述：

屬性：
1. property_name
聲明
說明

方法：
1. method_name
聲明
說明
參數
返回值
異常

注：
方法聲明中，假如碰到重載的方法，可以使用“”表示可以接受不同類型的參數，例如：“String value int value”；可以使用“[]”表示可選的參數，例如：“Object message[,Throwable t]”

ü Servlet設計(servlet document)
類名接受參數列表描述

ü 數據表設計(data modeling)
表名：some_table

說明：description

表結構：
字段名類型說明

6 代碼規范
6.1 Java源代碼規范
6.1.1 命名
u Package 的命名
Package 的名字應該都是由一個小寫單詞組成，例如：net.ebseries.modules。
此外，對于包名我們做如下約定：
1. 工具函數類包名前綴為.util
2. Servlet類包名前綴為.servlet
3. test case類包名前綴為.test

u Class 的命名
Class 的名字必須由大寫字母開頭而其他字母都小寫的單詞組成，例如：DataFile或InfoParser。

u Class 變量的命名
變量的名字必須用一個小寫字母開頭。后面的單詞用大寫字母開頭，例如：debug 或 inputFileSize。

u Static Final 變量的命名
Static Final 變量的名字應該都大寫，并且指出完整含義，例如：MAX_UPLOAD_FILE_SIZE=1024。

u 參數的命名
參數的名字必須和變量的命名規范一致。

u 數組的命名
數組應該總是用下面的方式來命名：
byte[] buffer;
而不是：
byte buffer[];

u 方法的參數
使用有意義的參數命名，假如可能的話，使用和要賦值的字段一樣的名字：
SetCounter(int size)

上一篇：軟件開發規范（1）

下一篇：如何在 Java 應用程序中讀取 8 位和 24 位 Microsoft Windows 位圖（轉）