Code standard

Code Standard
QUI ĐỊNH CHUNG VỀ CHUẨN LẬP TRÌNH
I. TỔ CHỨC TẬP TIN, THƯ MỤC
- Đặt tên tập tin ngắn gọn (độ dài tên tập tin nên <=8 ký tự)
- Lưu mỗi lớp trong một tập tin riêng biệt và tên tập tin phải trùng với tên lớp.
- Mỗi Namespace được đặt trong một thư mục riêng, phân cấp thư mục theo phân cấp
của Namespace
II. NGẮT DÒNG, THỤT VÀO ĐẦU DÒNG
- Khi một biểu thức quá dài, ta phải ngắt dòng biểu thức đó theo nguyên tắc sau:
o Ngắt sau dấu phẩy
o Ngắt sau phép toán
o Ngắt theo độ ưu tiên của các phép toán
o Canh lề dòng sau khi ngắt phải ngang bằng với dòng trên tại cùng độ ưu tiên
của phép toán
Ví dụ:
double x =a * b / (d – e + f) +
4 * g;
- Các dòng lệnh cùng cấp phải đặt thẳng hàng (canh lề trái), các dòng lệnh cấp con
phải thụt vào 1 khoảng Tab so với dòng lệnh cấp cha.
III. KHOẢNG TRẮNG
- Không được phép gõ 2 hoặc nhiều khoảng trắng liên tiếp nhau.
- Không được gõ khoảng trắng ở đầu dòng lệnh.
- Giữa các phép toán và toán hạng phải có khoảng trắng.
- Sau dấu phẩy phải có 1 khoảng trắng (trường hợp truyền tham số cho hàm)
IV. CHÚ THÍCH
- Chú thích 1 đoạn: sử dụng cặp dấu /*….*/
- Chú thích 1 dòng: sử dụng //
- Tất cả các hàm tự tạo đều phải có chú thích phía trước theo cú pháp sau:
Code Standard Trang 1
Code Standard
V. KHAI BÁO BIẾN

- Nên khai báo mỗi biến trên 1 dòng.
- Phía sau biến chú thích công dụng của biến, giá trị có thể nhận được (nếu cần)
Ví dụ:
int nCount = 0; // đếm số lượng mặt hàng thoả điều kiện
- Tất cả các biến khi khai báo đều phải khởi tạo giá trị ban đầu.
- Nếu có nhiều biến khai báo gần nhau  định dạng các khai báo đó theo dạng bảng
(table).
Ví dụ:
string strConn = “DSN=ABC”;
int nRow = 0;
float fTotal = 0;
VI. ĐỊNH NGHĨA LỚP / INTERFACE
- Dấu “{“ phải được đặt ở dòng kế tiếp sau dòng định nghĩa lớp (hoặc khai báo phương
thức)
- Dấu “}” phải được đặt thẳng hàng với dấu “{“ tương ứng của nó và phải được đặt
trên 1 dòng riêng.
- Giữa tên phương thức và dấu “(“ phía sau không có khoảng trắng.
- Bên trong 1 lớp / Interface, dữ liệu + phương thức phải được nhóm lại và được đặt
theo trình tự sau:
o Biến public
o Biến cục bộ
o Phương thức khởi tạo + huỷ
Code Standard Trang 2
<Summary>
*Description: <mô tả chức năng của hàm>
*Return: <Mô tả kết quả trả về của hàm>
*Input:
+ biến 1: <mô tả>
+ biến 2: <mô tả>
………………….

*Output: (đối với hàm có các biến tham chiếu)
+ biến 1: <mô tả>
+ biến 2: <mô tả>
</Summary>
Code Standard
o Các hàm xử lý sự kiện
o Các hàm tự tạo
(Có thể dùng #region để nhóm các biến, phương thức cùng loại lại với nhau)
VII. CÂU LỆNH
- Mỗi câu lệnh nên đặt trên 1 dòng riêng.
- Câu lệnh return cuối cùng trong hàm nên có dòng trống phía trước.
1. Câu lệnh if, if-else, if else – ifelse
if (điều kiện)
Lệnh P;
if (điều kiện)
Lệnh P;
else
Lệnh Q;
if (điều kiện 1)
Lệnh P1;
else if (điều kiện 2)
Lệnh P2;
………………………
else
Lệnh Q;
2. for / foreach
for (int i=0; i<n; i++)
{
Lệnh P1;
Lệnh P2;

…………
}
foreach (int i in IntList)
{
Code Standard Trang 3
Code Standard
Lệnh P1;
Lệnh P2;
…………
}
3. while / do-while
while (điều kiện)
Lệnh P;
do
{
Lệnh P1;
Lệnh P2;
……………
}while (điều kiện)
4. switch case
switch (điều kiện)
{
case <giá trị 1>:
Lệnh P1;
…………
break;
case <giá trị 2>:
Lệnh P1;
…………
break;

……………………
default:
Lệnh Q1;
………
}
Code Standard Trang 4
Code Standard
5. try-catch
try
{
…………
}catch()
{
………
}
Hoặc
try
{
………….
}catch(… )
{
…………
}
finally
{
………
}
6. Dòng trống (Blank Lines)
- Giữa các phương thức trong 1 lớp phải có 1 dòng trống tách biệt.
- Giữa các phương thức và các thuộc tính phải có 1 dòng trống.

- Giữa các biến cục bộ và câu lệnh đầu tiên trong phương thức nên có 1 dòng
trống (để dễ đọc)
- Giữa các phần (section) bên trong 1 phương thức nên có 1 dòng trống (để dễ
đọc)
VIII. QUI ƯỚC ĐẶT TÊN
1. Tên lớp
- Tên lớp phải là danh từ hoặc cụm danh từ
- Sử dụng cách viết hoa của Pascal
- Bắt đầu bằng tiếp đầu ngữ “cls”
Code Standard Trang 5
Code Standard
Ví dụ:
public class clsCustomers
{
}
2. Tên Interface
- Tên interface phải là danh từ, cụm danh từ hoặc tính từ
- Sử dụng cách viết hoa của Pascal
- Bắt đầu bằng tiếp đầu ngữ “I”
3. Tên phương thức (hàm)
- Tên phương thức sử dụng động từ hay cụm động từ.
- Sử dụng cách viết hoa của Pascal
- Tiếp đầu ngữ:
o Phương thức cục bộ: “mfnc”
o Phương thức toàn cục: ”pfnc”
o Phương thức tĩnh: ”sfnc”
4. Tên biến
- Các biến chạy dùng trong vòng lặp: i, j, k, l, m, n
- Các biến khác được đặt tên theo nguyên tắc sau:
[<Phạm vi>_]<tiếp đầu ngữ><tên biến>

Trong đó:
• Phạm vi:
+ Biến public trong lớp/interface: dùng “p”.
Đối với biến public chỉ input dữ liệu vào  dùng “pi”
Đối với biến public chỉ output dữ liệu vào  dùng “po”
+ Biến private/protected: dùng “m”
• Tiếp đầu ngữ: dựa vào kiểu dữ liệu của biến, dựa vào bảng sau
short s
int i
long l
char c
byte y
float f
double d
decimal dec
bool b
Code Standard Trang 6
Code Standard
uint ui
ushort us
ulong ul
string st
• Tên biến: Sử dụng cách viết hoa của Pascal
5. Tên Form
- Tên form đặt càng ngắn gọn càng tốt
- Sử dụng cách viết hoa của Pascal
- Dùng tiếp đầu ngữ: “frm”
6. Tên control trên form
- Tên control nên đặt ngắn gọn, mô tả được chức năng và công dụng của control
đó trên form.

- Sử dụng cách viết hoa của Pascal
- Dùng tiếp đầu ngữ dựa vào bảng sau đây:
Button btn
CheckBox chk
ComboBox cbo
Dialog dlg
DataTable tbl
ImageList iml
Label lbl
TextBox txt
ListBox lbx
ListView lv
MainMenu mm
MenuItem mnu
Panel pn
PictureBox pic
GroupBox grp
StatusBar stb
ToolBar tbr
ToolBarButton tbb
RadioButton rad
DataRow dr
DataGridView dgv
DateTimePicker dtp
Timer tmr
TabControl tab
TabPage tpg
NumericUpDown nud
UserControl usr
Code Standard Trang 7

Code Standard
Code Standard Trang 8