CHUẨN VIẾT CODE VÀ THIẾT KẾ GIAO DIỆN TRONG C# - Pdf 15

CHU N VI T CODE VÀ THI T K GIAO DI N TRONG C#Ẩ Ế Ế Ế Ệ
(B n tóm t t)ả ắ
I. QUY Đ NH Đ T TÊNỊ Ặ
- Pascal BackColor
- Camel backColor
- Uppercase BACKCOLOR
I.1. Tên bi nế
- Ki u Camelể
I.2. Tên h ng sằ ố
- S d ng Uppercaseử ụ
- G ch n i gi a các tạ ố ữ ừ
I.3. Tên ki u Enumể
- Tên ki u Pascalể
- Không ti n, h u tề ậ ố
I.4. Tham số
- Tên ki m Camelể
I.5. Tên thu c tínhộ
- Tên ki u Pascalể
I.6. Tên ph ng th cươ ứ
- Tên ki u Pascalể
I.7. S ki nự ệ
- Ki u Pascalể
- Th ng có h u t : EventHandlerườ ậ ố
I.8. Tên l pớ
- Tên ki u Pascalể
- Không s d ng g ch chânử ụ ạ
I.9. Giao di nệ
- Tên ki u Pascalể
- B t đ u b ng ti n t “I”ắ ầ ằ ề ố
I.10. Không gian tên
- Cú pháp: [Tên công ty].[Tên Công ngh ][.Đ c tr ng][.Thi t k ]ệ ặ ư ế ế

Label lbl lblHelpMessage
List box lst lstPolicyCodes
ListView lvw lvwHeadings
Menu mnu mnuFileOpen
Option button opt optGender
Picture box pic picVGA
Picture clip clp clpToolbar
ProgressBar prg prgLoadFile
RichTextBox rtf rtfReport
Slider sld sldScale
Spin spn spnPages
StatusBar sta staDateTime
Text Box txt txtLastName
Timer tmr tmrAlarm
Toolbar tlb tlbActions
TreeView tre treOrganization
UpDown upd updDirection
Vertical scroll bar vsb vsbRate
SqlDataSource sql sqlAccounts
LinqDataSource linq linqCategories
II. THI T K GIAO DI NẾ Ế Ệ
II.1. Thi t k formế ế
Thi t l p Option Layout Settings c a Form nh sau:ế ậ ủ ư
 Quy đ nh kích th c Formị ướ
Luôn c g ng đ m b o t l 4x3: Form r ng 4 thì cao 3 đ đ m b o cân x ngố ắ ả ả ỷ ệ ộ ể ả ả ứ
v i màn hình.ớ
 Quy đ nh kích th c Controlị ướ
o Chi u cao: s d ng chi u cao m c đ nh s n c a Control.ề ử ụ ề ặ ị ẵ ủ
Tr ng h p đ c bi t:ườ ợ ặ ệ
 TextBox multi-lines: đ m b o không b che 1 ph n c a dòngả ả ị ầ ủ

• Riêng v i Button thì luôn căn gi a.ớ ữ
 Chi u d c (VAlign): căn gi a (Middle)ề ọ ữ
 Dóng Control
o Label: dóng trái
o Textbox, Combo: dóng đ u hai bênề
 Tab Order:
o Ph i thi t l p Tab Order trên m i giao di n (Form, Control, …) theo nguyênả ế ậ ọ ệ
t c: t trái sang ph i, t trên xu ng d i.ắ ừ ả ừ ố ướ
o Yêu c u b t bu c thi t l p TabOrder theo đúng th t cho m i Control trênầ ắ ộ ế ậ ứ ự ọ
Form, k c Control không focus vào đ c nh Label, GroupBox, hay Controlể ả ượ ư
invisible. L u ý tuân th tuy t đ i quy đ nh này vì nó ph c v nhi u m c đíchư ủ ệ ố ị ụ ụ ề ụ
quan tr ng nh t o shortcut key, valid required data, …ọ ư ạ
 Anchor & Dock: ph i thi t l p Anchor và Dock cho Control trên các Form, Containerả ế ậ
không c đ nh kích th c (Sizable).ố ị ướ
 V i thông tin yêu c u ng i dùng không d c b tr ng mà b t bu c nh pớ ầ ườ ượ ỏ ố ắ ộ ậ
(AllowNull = FALSE) thì Label cho thông tin đó ph i s d ng ký hi u “(*)” cu iả ử ụ ệ ở ố
và thi t l p shortcut key.ế ậ
II.2. Quy đ nh khi t o MessageBoxị ạ
- Caption: s d ng ử ụ Application.ProductName
- Icon:
• MessageBoxIcon.Exclamation: dùng cho các tr ng h p sauườ ợ
o C nh báo l iả ỗ
o C nh báo xóa d li uả ữ ệ
o C nh báo nh p thi u, nh p sai d li uả ậ ế ậ ữ ệ
• MessageBoxIcon.Information: dùng cho các thông báo không có tính ch tấ
c nh báo, ví d K t qu Import, Thông tin v CSDL, … ả ụ ế ả ề
- N i dung Message: ộ không đ c phép vi t tr c ti p n i dung message mà ph i dùngượ ế ự ế ộ ả
Resource (s s ng hàm String.Format đ truy n tham s cho Resource n u c n).ử ụ ể ề ố ế ầ
II.3. Quy t c vi t mô t (comment) cho codeắ ế ả
S d ng ti ng Vi t có d u (Unicode) đ vi t comment.ử ụ ế ệ ấ ể ế

tháng tr cướ
// Modified by nvkieu - 25/02/2008: s a l i gì đóử ỗ
// Modified by nqhoang - 27/02/3008: b sung gì đóổ
private void GetDateLastMonth(fromDate datetime, toDate datetime, currentMonth int,
currentYear int)
{
if (currentMonth == 1)
{
fromDate = DateSerial(currentYear - 1, 12, 1);
toDate = DateSerial(currentYear - 1, 12, DaysInMonth(currentYear - 1, 12));
}
else
{
fromDate = DateSerial(currentYear, currentMonth - 1, 1);
toDate = DateSerial(currentYear, currentMonth - 1, DaysInMonth(currentYear,
currentMonth - 1));
}
…………………………….
}
- M u comment cho Method/Event ẫ ph c t pứ ạ :
/// <summary>
/// Di n gi i m c đíchễ ả ụ
///</summary>
///<param name="Tham s 1">Di n gi i cho Tham s 1</param>ố ễ ả ố
///<param name="Tham s 2">Di n gi i cho Tham s 2</param>ố ễ ả ố
/// …
/// <param name="Tham s n">Di n gi i cho Tham s n</param>ố ễ ả ố
/// <remarks>Nh n xét (n u có)</remarks>ậ ế
/// Created by (ng i t o) – (ngày/tháng/năm t o)ườ ạ ạ
/// Modified by (ng i s a 1) – (ngày/tháng/năm s a 1): di n gi i vi c s a 1ườ ử ử ễ ả ệ ử

}
Comment cho đo n Codeạ
- Nh ng đo n code ph c t p c n có comment g n li n bên trên đ chú gi i.ữ ạ ứ ạ ầ ắ ề ể ả
- Nh ng đo n code đ c s a đ i (modified), b sung (added) ho c rem (removed)ữ ạ ượ ử ổ ổ ặ
b i ng i không ph i tác gi c n có comment rõ ngay t i n i s a đ i, b sung:ở ườ ả ả ầ ạ ơ ử ổ ổ
ng i s a, ngày s a, m c đíchườ ử ử ụ .
- Comment cho đo n code áp d ng b t bu c v i các Base Form/Base Class/Baseạ ụ ắ ộ ớ
Control.
II.4. Quy t c phân nhóm (region) khi coding:ắ
Ph i s d ng Region phân nhóm code đ ti n cho vi c s a đ i, b o trì.ả ử ụ ể ệ ệ ử ổ ả
Phân nhóm code theo c u trúc nh sau: (theo th t b t bu c, nh ng không b t bu c cóấ ư ứ ự ắ ộ ư ắ ộ
đ t t c các region)ủ ấ ả
Declaration
Constructor
Property
Method/Function
Event
Tùy theo yêu c u c a các form, class và module, l p trình viên có th chia nh cácầ ủ ậ ể ỏ
Region chính trên thành các sub-region. VD: region Method/Function có th ch a cácể ứ
region con sau:
Method/Function
Public
Overridable (tr ng h p là base form/class)ườ ợ
Override (tr ng h p là derive form/class)ườ ợ
Private
Other
Tr ng h p form ho c class có s d ng các component đ c l p (Security, Document,ườ ợ ặ ử ụ ộ ậ
MassEmail,…) thì ph i t o các Region riêng cho t ng component, ch a toàn b codeả ạ ừ ứ ộ
liên quan đ n vi c t ng tác v i các component đó.ế ệ ươ ớ
II.5. Quy đ nh b y l i khi codingị ẫ ỗ


Nhờ tải bản gốc

Tài liệu, ebook tham khảo khác

Music ♫

Copyright: Tài liệu đại học © DMCA.com Protection Status