Phát triển ứng dụng - Quy tắc và cách viết code (review)

Môn: PHÁT TRIỂN ỨNG DỤNGPhần: Quy tắc và cách viết code (review)Nội dung1. Tổ chức và lưu tên file, thư mục2. Các kiểu quy ước viết hoa3. Cách tổ chức, đặt tên cho Function, Class4. Quy tắc đặt tên biến5. Comment trong quá trình viết Code6. Coding Plan7. Code Review Phần: Quy tắc và cách viết code (review)21. Tổ chức và lưu tên file, thư mụcQuy tắc đối với thư mụcTê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).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.Phần: Quy tắc và cách viết code (review)31. Tổ chức và lưu tên file, thư mục (tt)Quy tắc đối với File và đặt tên File :Tổ chức File: lưu phải đúng địa điểm, nằm đúng thư mục mô tả tác dụng của tập tin đó. Đặt tên FileTên File được lưu phải mô tả được nội dung của tập tin đó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 tập tin. Phần: Quy tắc và cách viết code (review)41. Tổ chức và lưu tên file, thư mục (tt)Quy tắc đặt tên chung:Java, C# phân biệt chữ thường và chữ hoa.Tên chỉ được phép bắt đầu bằng A-Z, a-z , $ , Tên không được trùng keywords của Java/C#.Phần: Quy tắc và cách viết code (review)52. Các kiểu quy ước viết hoaCó 3 quy tắc viết hoa:Pascal Case 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 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 sau phải được viết hoa.Uppercase Tất cả các ký tự trong từ định danh phải được viết hoa. Sử dụng quy tắc này đối với tên định danh có từ 2 ký tự trở xuống.Phần: Quy tắc và cách viết code (review)62. Các kiểu quy ước viết hoa (tt)VD trong ngôn ngữ lập trình C#Phần: Quy tắc và cách viết code (review)7Kiểu dữ liệu Kiểu quy ướcChú ýInterfacePascal CasingDùng tiền tố IEnumPascal CasingEventsPascal CasingExceptionPascal CasingKết thúc với hậu tố ExceptionPublic FieldsPascal CasingMethodsPascal CasingNamespacePascal CasingPropertyPascal CasingProtected/private FieldsCamel CasingParametersCamel Casing3. Cách tổ chức, đặt tên cho Function, ClassCách tổ chức Function, ClassClass, 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.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.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 Function trong C# có quy tắc như tên Class.Không sử dụng dấu cách (space) cho tên Class, Function. Nếu cần thiết sử dụng dấu gạch dưới ( _ ).Bắt buộc mô tả bằng dấu Comment về nội dung Class, Function, các biến truyền vào, các biến sẽ trả về.Phần: Quy tắc và cách viết code (review)84. Quy tắc đặt tên biếnTên biến phải mô tả rõ ràng nội dung của biến.Viết bằng chữ thường.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 ( _ ).Tên biến khai báo có hoặc không cần kiểu dữ liệu. 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.Phần: Quy tắc và cách viết code (review)95. Comment trong quá trình viết Code Đối với tất cả các loại ngôn ngữ, comment 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.Comment với tất cả Class, Function, Biến, quá trình xử lý điều kiện nào đó.Sử dụng comment theo 2 cách : dùng dấu ( //comment content ) hoặc cặp dấu (/* comment content*/)Tất cả nội dung trong comment bao gồm : Biến, Function, Class, Text. Phần: Quy tắc và cách viết code (review)105. Comment trong quá trình viết Code VD: Comment cho một lớp: /// /// The Person class provides /// public class Person {.}Phần: Quy tắc và cách viết code (review)11VD. Đặt tên cho các control trong C#Phần: Quy tắc và cách viết code (review)12Tiền tố Loại ControlTiền tố Loại ControlTiền tố Loại ControlTiền tố Loại ControllblLabelsplSplitterppcPrintPreviewControltabTabControlllblLinkLabeldudDomainUpDownerrErrorProviderdtmDateTimePickerbtnButtonnudNumericUpDownpdocPrintDocumentmonMonthCalendartxtTextboxtrkTrackBarpsdPageSetupDialogsbrScrollBarmnuMainMenuproProgressBarcrvCrystalReportDialogtmrTimerchkCheckBoxrtxtRichTextBoxpdPrintDialogsqldSqlDbCommandrdoRadioButtonimgImageListswFileSystemWatcherofdOpenFileDialoggrpGroupBoxhlpHelpProviderlogEventLogsdlSaveFileDialogpicPictureBoxtipToolTipdireDirectoryEntryfdFontDialoggrdGridcmnuContextMenudirsDirectorySearchercdColorDialoglstListBoxtbrToolBarmsqMessageQueuepdPrintDialogcboComboBoxfrmFormpcoPerformanceCounterppdPrintPreviewDialoglstvListViewbarStatusBarproProcessdsDataSettreTreeViewnicoNotifyIconserServiceControllerdvwDataViewVD. Đặt tên cho các control Java (swing/awt)Phần: Quy tắc và cách viết code (review)13Tiền tố Loại ControlTiền tố Loại ControlTiền tố Loại ControlbtnJbuttonmni JMenuItemtab JTabbedPaneJTablechkJCheckBoxopt JOptionPanetbl JTableclrJColorChooserpnl JPaneltbh JTableHeadercmbJComboBoxpmn JPopupMenutxa JTextAreaicoJDesktopIconprg JProgressBartxt JTextFieldedtJEditorPanerad JRadioButtontxp JTextPanefchJFileChooserrot JRootPanetgl JToggleButtonifr JInternalFramescb JScollBartlb JToolBarlbl JLabelscr JScrollPanetlt JToolTiplyp JLayeredPanespr JSeparatortre Jtreelst Jlistsld JSlidervpr Jviewportmnu JMenuBarspn JSpinnerwin JWindow and descendants (JFrame, JDialog, JFileDialog) 6. Coding WorkflowPhần: Quy tắc và cách viết code (review)147. Review Code3 phương pháp review code review chéo (giữa 2 lập trình viên với nhau), cả nhóm ngồi họp cùng reviewtechnical leader review. Phần: Quy tắc và cách viết code (review)157. Review Code (tt)Lợi ích của Review code do cả nhóm thực hiệnĐảm bảo code ngắn gọn, rõ ràng, hiệu năng tốt hơn.Phát hiện lỗi sớm (cá nhân có thể quên các tình huống kiểm thử)Nâng cao kỹ năng lập trình.Đồng bộ hóa các công việc trong nhóm.Góp ý xây dựng chương trình (về UI, về các mẫu thiết kế code.Phần: Quy tắc và cách viết code (review)16Phần: Quy tắc và cách viết code (review)17