Bài giảng Phát triển ứng dụng: Chương 3.5

Bài giảng Phát triển ứng dụng: Chương 3.5 được biên soạn nhằm mục đích phục vụ cho việc giảng dạy. Nội dung bài giảng gồm: Tổ chức và lưu tên file, thư mục Các kiểu quy ước viết hoa, cách tổ chức, đặt tên cho Function, Class, quy tắc đặt tên biến Comment trong quá trình viết Code, Coding Plan, Code Review,...
Nội dung trích xuất từ tài liệu:
Bài giảng Phát triển ứng dụng: Chương 3.5 Môn: PHÁT TRIỂN ỨNG DỤNG Phần: Quy tắc và cách viết code (review) Nội dung 1. Tổ chức và lưu tên file, thư mục 2. Các kiểu quy ước viết hoa 3. Cách tổ chức, đặt tên cho Function, Class 4. Quy tắc đặt tên biến 5. Comment trong quá trình viết Code 6. Coding Plan 7. Code Review  1. Tổ chức và lưu tên file, thư mục Quy tắc đối với thư mục o Tên thư mục phải trực quan, mô tả được tác  dụng của những file chứa bên trong và được tối  ưu nhất (không dồn tất cả các file vào một thư  mục nếu không cùng với mục đích của thư  mục). o Tên thư mục không nên đặt in hoa, tất cả ký tự  nên là chữ thường, không sử dụng dấu cách  trong khi đặt thư mục, nếu cần thiết sử dụng  dấu gạch dưới ( _ ) để đặt tên. 1. Tổ chức và lưu tên file, thư mục  Quy tắc đối với File và đặt tên File : (tt)Tổ chức File: lưu phải đúng địa điểm, nằm  o đúng thư mục mô tả tác dụng của tập tin đó.  o Đặt tên File n Tên File được lưu phải mô tả được nội dung  của tập tin đó n Tên File không sử dụng dấu cách (space),  nếu cần thiết sử dụng dấu gạch dưới ( _ ),  không nên dùng tiếng Việt có dấu đặt tên  1. Tổ chức và lưu tên file, thư mục  Quy tắc đặt tên chung: (tt)Java, C# phân biệt chữ thường và chữ hoa. o o Tên chỉ được phép bắt đầu bằng A­Z, a­z , $ ,  … o Tên không được trùng keywords của Java/C#. 2. Các kiểu quy ước viết hoa Có 3 quy tắc viết hoa: Pascal Case  o Chữ cái đầu tiên trong từ định danh và chữ cái  đầu tiên của mỗi từ nối theo sau phải được viết  hoa. Sử dụng Pascal Case để đặt tên cho một  tên có từ 3 ký tự trở lên. Camel Case  o Chữ cái đầu tiên trong từ định danh là chữ  thường và chữ cái đầu tiên của mối từ nối theo  2. Các kiểu quy ước viết hoa (tt) o VD trong ngôn ngữ lập trình C# Kiểu dữ liệu  Kiểu quy ước Chú ý Interface Pascal Casing Dùng tiền tố I Enum Pascal Casing Events Pascal Casing Exception Pascal Casing Kết thúc với hậu tố Exception Public Fields Pascal Casing Methods Pascal Casing Namespace Pascal Casing Property Pascal Casing Protected/private Fields Camel Casing Parameters Camel Casing 3. Cách tổ chức, đặt tên cho  Cách tổ chức Function, Class Function, Class o Class, Function khai báo tên có mục đích rõ ràng,  mô tả được công việc mà Class (lớp) và các  Funtion (phương thức) của lớp thực hiện. o Tên Class (dùng danh từ) không bắt đầu bằng  số, bắt buộc bắt đầu bằng chữ cái và viết HOA  chữ cái đầu tiên. o Tên của các phương thức phải là động từ. Tên  Function trong Java: bắt đầu bằng 1 ký tự  thường và viết hoa chữ cái đầu tiên. Tên  4. Quy tắc đặt tên biến o Tên biến phải mô tả rõ ràng nội dung của biến. o Viết bằng chữ thường. o Không sử dụng dấu cách (space) khi đặt tên,  nếu cần thiết sử dụng dấu ( _ ). o Tên biến khai báo có hoặc không cần kiểu dữ  liệu.  o Khi khai báo biến phải sử dụng comment để  nêu rõ tác dụng và nội dung biến sẽ chứa. 5. Comment trong quá trình viết  Đối với tất cả các loại ngôn ngữ, comment  Code  o trong quá trình viết code rất quan trọng, nó sẽ  mô tả được các thông tin và điều mà người lập  trình cần lưu ý đối với người đọc và chỉnh sửa  code sau này. o Comment với tất cả Class, Function, Biến, quá  trình xử lý điều kiện nào đó. o Sử dụng comment theo 2 cách : dùng dấu (  //comment content ) hoặc cặp dấu (/* comment  content*/) 5. Comment trong quá trình viết  VD: Comment cho một lớp:  Code  ///  /// The Person class provides … ///  public class Person {….} VD. Đặt tên cho các control trong  Tiền tố  Loại Control Tiền tố  Loại Control Tiền tố  Loại Control Tiền tố  Loại Control C# lbl llbl Label LinkLabel spl dud Splitter ppc DomainUpDown err PrintPreviewControl ErrorProvider tab dtm TabControl DateTimePicker btn Button nud NumericUpDown pdoc PrintDocument mon MonthCalendar txt Textbox trk TrackBar psd PageSetupDialog sbr ScrollBar mnu MainMenu pro ProgressBar crv CrystalReportDialog tmr Timer chk CheckBox rtxt RichTextBox pd PrintDialog sqld SqlDbCommand rdo RadioButton img ImageList sw FileSystemWatcher ofd OpenFileDialog grp GroupBox hlp HelpProvider log EventLog sdl SaveFileDialog pic PictureBox tip ToolTip dire DirectoryEntry fd FontDialog grd Grid cmnu ContextMenu dirs DirectorySearcher cd ColorDialog lst ListBox tbr ToolBar msq MessageQueue pd PrintDialog cbo ComboBox frm Form pco PerformanceCounter ppd PrintPreviewDialog lstv ListView bar StatusBar pro Process ds DataSet tre TreeView nico NotifyIcon ser ServiceController dvw DataView VD. Đặt tên cho các control Java  Tiền tố  Loại Control Tiền tố  Loại Control Tiền tố  Loại Control (swing/awt) btn c ...