Phong cách lập trình. (Góp nhặt)

Qui tắc đặt tên biến:

C# phân biệt chữ hoa chữ thường, tức là new khác với New, writeline khác với WriteLine; nhưng IDE của C# lại không sửa những lỗi về chữ hoa chữ thường cho bạn. Nếu bạn viết 2 lần cùng 1 từ, nhưng chữ hoa chữ thường khác nhau thì có thể sẽ gây ra lỗi khó lòng phát hiện được.

Để đỡ mất thời giờ vào việc tìm những lỗi không đâu, và để làm nhóm hiệu quả, bạn nên tuân thủ qui tắc đặt tên mà đa số lập trình viên C# đều theo. Cụ thể là:

+ Ký hiệu "lưng gù lạc đà" (Camel notation): mẫu tự đầu tiên của từ đầu tiên viết chữ thường. VD: someVariableName, luongCanBan, maSoNhanVien,...
Kiểu kí hiệu này dùng cho tên biến.

+ Ký hiệu Pascal: mẫu tự đầu tiên của mỗi từ trong tên được viết hoa. Ví dụ: SomeFuntion, AddNumber,...
Kiểu ký hiệu này dùng để viết tên hàm, hằng, thuộc tính, Namespace, lớp.

+ Không dùng ký pháp Hungarian nữa. Trước đây, các lập trình viên thường dùng lối này, theo đó lấy tên kiểu dữ liệu làm tiền tố cho tên biến, và m_ là tiền tố cho biến thành viên. Chẳng hạn: int nAge; string m_sName;

+ Không viết tắt tên, trừ trường hợp không thể làm khác. Chẳng hạn:
Không viết nam mà viết name
Không viết addr mà viết address

+ Không đặt tên biến chỉ có 1 kí tự, trừ biến đếm (thường đặt là i, j).

+ Tên biến nên có ý nghĩa liên qua tới việc đang làm. Với tên hàm nên là động từ, ví dụ: TinhTien

+ Không dùng dấu gạch dưới "_" trong tên, như: Luong_Thang

+ Namespace phải đặt theo cấu trúc sau:

Code:

<tên công ty>.<tên sản phẩm>.<module cấp cao hơn>.<module cấp thấp hơn>

Các khối mã cần có độ thụt thò để trông chương trình được sáng sủa.
Chú ý: Dùng phím TAB để căn lề, không dùng dấu cách.

Hãy quan sát các đoạn mã mẫu:


Tốt

Code:

if ( ... )
  {
  // Do something

  }

Vứt đi

Code:

if ( ... ) {
  // Do something

  }

---

Tốt

Code:

if ( showResult == true )
  {
  for ( int i = 0; i < 10; i++ )
  {
    //

  }
  }

Vứt đi

Code:

if(showResult==true)
  {
  for(int i= 0;i<10;i++)
  {
    //

  }
  }

Thông thường, người ta đề nghị nên cho các biến thành viên của một lớp về private. Đây có nghĩa là chỉ những hàm thành viên thuộc lớp này mới có thể truy xuất các biến này. Vì private là cấp truy xuất mặc nhiên (default), nên bạn có thể không viết ra cũng được, nhưng theo tập quán lập trình tốt, ta nên viết rõ ra private.