Tài liệu Codingconvention

STH VIETNAM Java Coding Convention Phiên bản 1.2 1 STH VIETNAM Revision History Date Version Description Author 2 STH VIETNAM MỤC LỤC MỤC LỤC...........................................................................................................................3 1 GIỚI THIỆU....................................................................................................... 5 1.1 1.2 1.3 1.4 2 CÁC QUY TẮC CHUNG....................................................................................... 6 2.1 2.2 3 Định dạng của Implementation Comment.............................................................12 Documentation Comments...................................................................................14 DECLARATIONS............................................................................................... 16 7.1 7.2 7.3 7.4 7.5 8 Tab và Indent......................................................................................................10 Dấu ngoặc nhọn.................................................................................................10 Độ dài dòng lệnh................................................................................................10 Ngắt dòng...........................................................................................................10 CHÚ THÍCH (COMMENTS)..............................................................................12 6.1 6.2 7 File mã nguồn Java...............................................................................................8 INDENTATION AND BRACES.........................................................................10 5.1 5.2 5.3 5.4 6 Phần mở rộng file.................................................................................................7 Các file thường sử dụng.......................................................................................7 TỔ CHỨC FILE.................................................................................................... 8 4.1 5 Đơn giản - Chính xác............................................................................................6 Sự vi phạm các quy tắc chuẩn...............................................................................6 CẤU TRÚC CHƯƠNG TRÌNH.............................................................................7 3.1 3.2 4 Mục đích...............................................................................................................5 Phạm vi ứng dụng................................................................................................5 Các tài liệu liên quan.............................................................................................5 Định nghĩa............................................................................................................5 Số lượng khai báo trên một dòng........................................................................16 Khai báo kiểu mảng (Array Declaration)................................................................16 Khởi tạo (Initialization)........................................................................................16 Nơi đặtkhai báo (Placement)................................................................................16 Khai báo Class và Interface (Class and Interface Declarations)...............................17 CÁC CÂU LỆNH (STATEMENTS).....................................................................18 8.1 8.2 8.3 8.4 8.5 Các câu lệnh đơn giản (Simple Statements)..........................................................18 Các câu lệnh phức (Compound Statements).........................................................18 Câu lệnh trả về (Return Statements)....................................................................18 Các câu lệnh if, if-else, if else-if else.....................................................................18 Câu lệnh for........................................................................................................19 3 STH VIETNAM 8.6 8.7 8.8 8.9 9 Dòng trống (Blank Lines).....................................................................................21 Ký tự trống.........................................................................................................21 Một số quy ước chung (General Rules).................................................................22 Class/Interface....................................................................................................22 Biến số (Variables)..............................................................................................23 Hằng số(Constants).............................................................................................23 Phương thức (Methods)......................................................................................23 PROGRAMMING PRACTICES..........................................................................25 11.1 11.2 11.3 11.4 11.5 11.6 11.7 12 While....................................................................................................19 Do-while...............................................................................................19 Switch..................................................................................................20 Try-catch...............................................................................................20 QUY ƯỚC ĐẶT TÊN (NAMING CONVENTIONS)...........................................22 10.1 10.2 10.3 10.4 10.5 11 lệnh lệnh lệnh lệnh KHOẢNG TRẮNG (WHITE SPACE).................................................................21 9.1 9.2 10 Câu Câu Câu Câu Providing Access to Instance and Class Variables...................................................25 Tham chiếu đến Class Variables và Methods.........................................................25 Hằng số (Constants)............................................................................................25 Phép gán (Variable Assignments)..........................................................................25 Loggings.............................................................................................................26 Performance Practices..........................................................................................26 Miscellaneous Practices........................................................................................26 CODE EXAMPLES............................................................................................. 28 12.1 Một ví dụ Java Source File...................................................................................28 4 STH VIETNAM 1 GIỚI THIỆU 1.1 Mục đích Các quy ước về viết code đóng vai trò quan trọng đối với lập trình viên vì những lý do sau :  80% chi phí cho vòng đời của một phần mềm là dành cho việc bảo trì  Hầu như bất cứ phần mềm nào cũng được bảo trì toàn bộ bởi người viết phần mềm đó.  Quy ước về viết code cải thiện tính dễ đọc của phần mềm, cho phép lập trình viên có thể hiểu code mới một cách nhanh chóng và hoàn thiện. Nếu mã nguồn của bạn đóng vai trò là một sản phẩm, bạn cần đảm bảo nó được đóng gói một cách hoàn thiện và rõ ràng như bất cứ một sản phẩm phần mềm nào khác. 1.2 Phạm vi ứng dụng 1.3 Các tài liệu liên quan No. 1 1.4 Code SUN Java Conventions Tên tài liệu Coding Java Language Specification – Sun Microsystems, Inc. http://java.sun.com/docs/codeconv/ Định nghĩa Khái niệm Giải thích 5 STH VIETNAM 2 CÁC QUY TẮC CHUNG 2.1 Đơn giản - Chính xác  Code phải đơn giản và dễ hiểu  Code phải chính xác và chắc chắn Cần có một quy tắc chung về khoảng cách, indent, tên, access modifiers …  Không nên tối ưu hóa code một cách vội vàng Trừ khi bạn thực hiện xuất nhập dữ liệu hoặc thực hiện hàng triệu lần với cùng một thao tác, không nên tối ưu hóa code một cách vội vàng. 2.2 Sự vi phạm các quy tắc chuẩn Không có tiêu chuẩn nào là hoàn hảo và cũng không có tiêu chuẩn nào có thể áp dụng được trong mọi trường hợp: có thể bạn sẽ gặp trường hợp không thể áp dụng một hoặc nhiều tiêu chuẩn nào đó.  Bất cứ sự vi phạm tiêu chuẩn nào cải thiện tính dễ đọc thì đều có thể được chấp nhận Mục tiêu chính của tài liệu là cải thiện tính dễ đọc do đó tăng khả năng hiểu, duy trì và chất lượng chung của code. Tuy nhiên bạn cũng nên hiểu rằng nó không thể bạo quát hết các trường hợp cụ thể.  Khi bạn vi phạm tiêu chuẩn, hãy ghi lại những thay đổi này Tất cả các tiêu chuẩn đều có thể bị thay đổi. Nếu bạn làm vậy, bạn cần ghi lại lí do bạn thay đổi tiêu chuẩn, các điều kiện có thể/ phải xảy ra trước khi tiêu chuẩn có thể áp dụng vào trường hợp này. Cuối cùng, bạn cần hiểu mỗi tiêu chuẩn, hiểu được khi nào thì áp dụng chúng cũng như trường hợp không thể áp dụng.  Các dự án có thể điều chỉnh lại tài liệu này cho riêng dự án Dựa trên yêu cầu của khách hàng, các dự án có thể sử dụng tiêu chuẩn code được cung cấp bởi khách hàng hoặc điều chỉnh lại tài liệu chuẩn này cho phù hợp với yêu cầu riêng của khách hàng. 6 STH VIETNAM 3 CẤU TRÚC CHƯƠNG TRÌNH Phần này sẽ liệt kê các phần mở rộng và tên file thường sử dụng. 3.1 Phần mở rộng file Phần mềm viết bằng ngôn ngữ Java sử dụng các phần mở rộng file sau : Kiểu file Phần mở rộng Mã nguồn Java Mã nhị phân Java 3.2 .java .class Các file thường sử dụng Các file thường sử dụng bao gồm : Tên file README Mục đích File tổng kết nội dung của một thư mục 7 STH VIETNAM 4 TỔ CHỨC FILE Một file bao gồm nhiều phần, các phần này nên được tách biệt nhau bởi các dòng trống và các chú thích không bắt buộc để xác định mỗi phần. File có độ dài hơn 2000 dòng hoặc có nhiều hơn 50 phương thức sẽ rất nặng nề và nên tránh. Ví dụ về một chương trình Java mẫu, viết đúng định dạng xem trong phần "Ví dụ file mã nguồn Java" trong trang 19. 4.1 File mã nguồn Java Mỗi file mã nguồn Java chứa một public class đơn hoặc một interface. Nếu các private class và interface được kết hợp với một public class, bạn có thể đặt chúng trong cùng file mã nguồn dưới dạng một public class. Public class nên là class hoặc interface đầu tiên trong file. File mã nguồn Java có thứ tự như sau :  Các chú thích ban đầu (xem "Beginning Comments" trong trang 4)  Các câu lệnh pakage và import.  Các khai báo class và interface (xem "Khai báo Class và Interface" trong trang 4) 4.1.1 Chú thích ban đầu Tất cả các file mã nguồn của một dự án nên có chung định dạng của chú thích ban đầu, chứa các thông tin như tên class, thông tin phiên bản, thời gian, ghi chú về copyright, các log về sự thay đổi mã nguồn … Đây là một ví dụ mẫu về định dạng chú thích ban đầu: /* * Copyright (C) 2005 by SthVietnam Software Company * * $Id: Blah.java,v 1.1 2006/01/11 03:43:05 quangtn Exp $ * */ 4.1.2 Các câu lệnh Pakage và Import Câu lệnh pakage là câu lệnh đầu tiên mà không phải là chú thích của hầu hết các file mã nguồn Java. Trong công ty SthVietnam, tất cả các pakage Java luôn được bắt đầu bằng net.SthVietnam, trừ trường hợp được quy định bởi khách hàng. Tiếp theo sẽ là các câu lệnh import. Ví dụ: package net.SthVietnam.util; 8 STH VIETNAM import java.awt.peer.CanvasPeer; Ghi chú: phần tử đầu tiên của một package luôn viết bằng kí tự ASCII thường và nên là một trong các tên miền top-level, hiện tại làc các tên miền com, edu, gov, mil, net, org hoặc một trong các mã 2 ký tự bằng tiếng Anh để xác định tên quốc gia (quy định trong chuẩn 3166 của ISO). 4.1.3 Khai báo Class và Interface Bảng dưới đây mô tả các thành phần của một khai báo class hoặc interface theo đúng thứ tự mà nó sẽ xuất hiện. Xem ví dụ "Java Source File Example" trong trang 19. No 1 2 3 Phần khai báo của Class/Interface Chú thích tài liệu Class/interface Ghi chú Xem chi tiết "Chú thích tài liệu" trong trang 9 (/**...*/) Câu lệnh class or interface Chú thích cài đặt Class/interface (nếu cần thiết) (/*...*/) Phần chú thích này chứa các thông tin về class hoặc interface mà không thuộc vào phần chú thích tài liệu. 4 Các hằng số (static final) Đầu tiên là các hằng số public, sau đó đến protected, tiếp theo là hằng số mức package (không có access modifier), và cuối cùng là private. 5 Các biến của Class (static) Đầu tiên là các biến public, sau đó đến protected, tiếp theo là hằng số mức package (không có access modifier), và cuối cùng là private. 6 Các biến của instance Đầu tiên là các biến public, sau đó đến protected, tiếp theo là hằng số mức package (không có access modifier), và cuối cùng là private. 7 Constructors 8 Các phương thức 9 Các phương thức này nên được nhóm theo chức năng, chứ không nên nhóm theo phạm vi hoặc khả năng truy nhập. Ví dụ, một phương thức của lớp có kiểu private có thể nằm giữa 2 phương thức của instance kiểu public. Mục đích là làm cho việc đọc hiểu code dễ dàng hơn. Inner classes/interfaces 9 STH VIETNAM 5 INDENTATION AND BRACES 5.1 Tab và Indent Một đơn vị của indent được tính bằng 4 kí tự trống. Không nên sử dụng kí tự tab vì các trình biên soạn khác nhau thì kí tự này lại khác nhau. Indent tiếp theo sẽ là 8 kí tự trống ( bằng 2 mức indent thường). 5.2 Dấu ngoặc nhọn Dấu ngoặc nhọn mở “{“ của khai báo class/ method và các khối lệnh khác nên đặt tại cuối của dòng lệnh đầu tiên trong khối lệnh đó. 5.3 Độ dài dòng lệnh Tránh viết dòng lệnh dài hơn 80 hoặc 120 kí tự vì một số tool sẽ không xử lý tốt được những dòng lệnh này. Ghi chú: Các đoạn code trong các tài liệu nên có độ dài ngắn hơn bình thương, nhỏ hơn 70 kí tự. 5.4 Ngắt dòng Khi một biểu thức dài hơn một dòng đơn, cần ngắt chúng theo nguyên tắc sau :  Ngắt sau dấu phẩy  Ngắt sau toán tử logic  Ngắt trước toán tử  Những quy ước ngắt có độ ưu tiên cao hơn sẽ được ưu tiên trước.  Căn dòng mới được ngắt cùng cấp với dòng trước nó.  Nếu quy tắc trên dẫn đến sự nhầm lẫn code hoặc code vượt quá lề phải thì sử dụng indent với 8 kí tự trống để thay thế Dưới đây là một số ví dụ ngắt các lời gọi phương thức: someMethod(longExpression1, longExpression2, longExpression3, longExpression4, longExpression5); var = someMethod1(longExpression1, someMethod2(longExpression2, longExpression3)); Dưới đây là 2 ví dụ ngắt dòng cho các biểu thức số học. Ví dụ đầu iên được ưu tiên sử dụng do vị trí ngắt nằm bên ngoài biểu thức trong ngoặc đơn (là biểu thức có độ ưu tiên cao hơn). 10 STH VIETNAM longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; // NÊN SỬ DỤNG longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; // NÊN TRÁNH Dưới đây là 2 ví dụ khi sử dụng indent trong khai báo phương thức. Đầu tiên là trường hợp theo quy ước. Trường hợp 2, nếu sử dụng indent theo quy ước sẽ làm cho dòng thứ 2 và thứ 3 kéo dài về bên phải, do đó sử dụng ident bằng 8 dấu cách. //INDENT THEO QUY ƯỚC someMethod(int anArg, Object anotherArg, String yetAnotherArg, Object andStillAnother) { ... } //SỬ DỤNG 8 DẤU CÁCH ĐỂ TRÁNH CÁC INDENT DÀI private static synchronized horkingLongMethodName(int anArg, Object anotherArg, String yetAnotherArg, Object andStillAnother) { ... } Ngắt dòng cho biểu thức if nên sử dụng quy tắc 8 dấu cách do việc sử dụng 4 dấu cách làm cho phần body của biểu thức khó theo dõi. Ví dụ: //KHÔNG SỬ DỤNG CÁCH INDENT NÀY if ((condition1 && condition2) || (condition3 && condition4) || !(condition5 && condition6)) { doSomethingAboutIt(); } //NGẮT SAI //KHIẾN CHO DỄ NHẦM LẪN DÒNG NÀY //THAY VÀO ĐÓ SỬ DỤNG CÁCH INDENT SAU if ((condition1 && condition2) || (condition3 && condition4) || !(condition5 && condition6)) { doSomethingAboutIt(); } //HOẶC SỬ DỤNG if ((condition1 && condition2) || (condition3 && condition4) || !(condition5 && condition6)) { doSomethingAboutIt(); } Dưới đây là 3 cách để định dạng biểu thức điều kiện rút gọn. alpha = (aLongBooleanExpression) ? beta : gamma; alpha = (aLongBooleanExpression) ? beta : gamma; alpha = (aLongBooleanExpression) 11 STH VIETNAM ? beta : gamma; 12 STH VIETNAM 6 CHÚ THÍCH (COMMENTS) Trong các chương trình Java ta có thể dùng hai cách chú thích: implementation comments và documentation comments. Implementation comments là những comment có thể thấy trong C++ như /*... */ và //. Documentation comment (hay còn gọi là “doc comment”) là những comment của riêng Java và được giới hạn trong /**...*/. Doc comments có thể được xuất thành các file HTML khi sử dụng javadoc tool. Implementation comments là các comment dùng cho việc tạm chú thích một đoạn code mà có thể về sau cần dùng đến hoặc để chú thích cho một đoạn implement riêng biệt nào đó. Doc comments dùng để mô tả các tính năng của đoạn mã để sao cho một người lập trình khi không có đoạn source code đó trong tay cũng có thể hiểu được đoạn code đó làm việc gì. Comment nên được sử dụng để đưa các thông tin chung về code và cung cấp thêm các thông tin mà nếu chỉ đọc code không thì sẽ khó nhận ra. Comment chỉ nên chứa các thông tin liên quan đến việc đọc hiểu chương trình. Ví dụ các thông tin như package này được tạo như thế nào và nó nằm trong directory nào thì không nên đưa vào comment. Đưa ra các comment cho những đoạn phức tạp, khó hiểu là một việc làm thích hợp, nhưng đối với những đoạn code được coi là “dễ hiểu”, bản thân nó đã chỉ rõ ra nó đang làm gì thì không nên comment nó nữa. Chú ý: Quá nhiều comment sẽ làm giảm chất lượng code. Do đó, khi bạn cảm thấy buộc phải viết comment thì hãy nên suy nghĩ xem liệu mình có thể làm cho đoạn code đó trở nên dễ đọc hơn không. Comment không nên để trong một khung lớn được bao bằng các ký tự đặc biệt hay các ký tự khác. Comment không nên chứa các ký tự đặc biệt như form-feed và backspace. 6.1 Định dạng của Implementation Comment Chương trình có thể có 4 loại implementation comments: theo khối (block), dòng đơn (single-line), comment theo code (trailing) và comment cuối dòng (end-of-line). 6.1.1 Block Comments Các block comment được dùng để mô tả files, phương thức (methods), cấu trúc dữ liệu và thuật toán. Block comments có thể được sử dụng ở đầu của mỗi file và trước mỗi một method. Nó còn có thể được sử dụng ở các chỗ khác như ở bên trong các method. Các block comment khi ở bên trong method hoặc function thì phải được viết lùi vào bằng với mức của các code mà nó muốn chú thích. Một block comment thì trước nó phải được đặt một dòng trống để phân cách nó với phần còn lại của code, khỏi bị lẫn. /* 13 STH VIETNAM * Đây là một block comment. */ Block comment bắt đầu bằng /*-, được xác định bởi indent(1), là phần đầu của block comment và không nên định dạng lại. Ví dụ: /** Here is a block comment with some very special * formatting that I want indent(1) to ignore. * * one * two * three */ Chú ý: Nếu bạn không sử dụng indent(1), bạn không cần phải sử dụng /*- trong code của bạn hoặc làm một concessions nào đó mà có lẽ một ai đó có thể run indent(1) trên code của bạn. Xem thêm "Documentation Comments" ở trang 9. 6.1.2 Single-Line Comments Các comment ngắn có thể xuất hiện trên một dòng cùng mức với đoạn code theo sau nó. Nếu một comment không thể viết trên một dòng được, thì nên đặt nó trong block comment (Xem phần 6.1.1). Phía trước một single-line comment nên đặt một dòng trống. Đây là một ví dụ của một single-line comment trong Java (xem thêm "Documentation Comments" ở trang 9): if (condition) { // Handle the condition. ... } 6.1.3 Trailing Comments Các comment “rất ngắn” có thể xuất hiện trên cùng một dòng với code mà nó muốn mô tả, nhưng nó phải được đẩy ra đủ xa để có thể phân biệt nó với phần câu lệnh. Nếu trong một đoạn code có nhiều hơn 1 short comment thì tất cả nên được viết thụt vào cùng mức với nhau. Dưới đây là một ví dụ của trailing comment trong Java: if (a == 2) { return TRUE; } else { return isPrime(a); } 6.1.4 // special case // works only for odd a End-Of-Line Comments Comment // có thể comment out toàn bộ một dòng hoặc một phần của dòng đó. Không nên sử dụng nó một cách liên tục để comment các đoạn text; tuy nhiên, nó có thể được 14 STH VIETNAM dùng liên tục để comment out một đoạn code. Ví dụ sau đây là 3 kiểu comment sử dụng end-of-line comment: if (foo > 1) { // Do a double-flip. ... } else { return false; // Explain why here. } //if (bar > 1) { // // Do a triple-flip. // ... //} else { // return false; //} 6.2 Documentation Comments Chú ý: Xem các ví dụ về các định dạng comment được mô tả tại đây ở phần "Java Source File Example" - trang 19 Để biết thêm chi tiết, bạn có thể đọc "How to Write Doc Comments for Javadoc" bao gồm cả các thông tin khác cho các tag của doc comment như (@return, @param, @see): http://java.sun.com/products/jdk/javadoc/writingdoccomments.html Các thông tin thêm về doc comments và javadoc, xin mời ghé qua trang chủ của javadoc tại : http://java.sun.com/products/jdk/javadoc/ Doc comment mô tả các Java class, interfaces, constructors, methods, và fields. Mỗi doc comment được đặt trong /**...*/, và với mỗi class, interface, hoặc member đều có một doc comment. Comment này nên được đặt ngay phía trước phần khai báo: /** * The Example class provides ... */ public class Example { ... Chú ý là các top-level classes và các interfaces thì không bị viết thụt vào, còn các member của nó thì phải viết thụt vào. Dòng đầu tiên của doc comment (/**) cho các classes và interfaces không viết thụt; các dòng tiếp theo của doc comment được viết thụt vào một khoảng trắng, thẳng hàng với * ở phía trên. Đối với các members, kể cả các constructors thì có 4 khoảng trắng ở dòng đầu của doc comment và các dòng sau thì là 5 khoảng trắng. Nếu bạn cần đưa thông tin về class, interface, variable, hoặc method mà nó không thích hợp với việc tạo documentation thì sử dụng implementation block comment (xem phần 6.1.1) hoặc single-line (xem phần 6.1.2) comment ngay phía sau phần khởi tạo. Ví dụ, 15 STH VIETNAM chi tiết về việc implementation một class nên được đặt trong một implementation block comment đặt sau class statement, không nên đặt trong phần class doc comment. Doc comments không nên đặt trong phần định nghĩa method hoặc constructor, vì Java liên kết documentation comments với phần khai báo ngay sau comment đó. 16 STH VIETNAM 7 7.1 DECLARATIONS Số lượng khai báo trên một dòng Nên sử dụng mỗi khai báo trên một dòng vì nó thuận tiện cho việc ghi comment. Hay nói cách khác, nên sử dụng kiểu:, int level; // indentation level int size; // size of table hơn là cách khai báo int level, size; Không nên khai báo các biến với các kiểu khác nhau trên cùng một dòng, ví dụ: int foo, fooarray[]; //SAI! Chú ý: Các ví dụ trên sử dụng một space giữa kiểu và biến. Một cách khác là sử dụng tab, ví dụ: int level; int size; Object currentEntry; 7.2 // indentation level // size of table // currently selected table entry Khai báo kiểu mảng (Array Declaration) Mặc dù Java hỗ trợ 2 cách khai báo kiểu mảng, nhưng chúng ta nên chỉ đi theo một kiểu khai báo như sau: int anIntArray[]; int[] anIntArray; 7.3 // Không nên // Nên theo cách này Khởi tạo (Initialization) Nên khởi tạo các biến cục bộ ngay khi chúng được khai báo. Chỉ có một lý do duy nhất để không nên khởi tạo chúng ngay khi khai báo là khi giá trị khởi tạo của nó phải phụ thuộc vào một tính toán nào đó trước. 7.4 Nơi đặt khai báo (Placement) Chỉ đặt các khai báo ở phần đầu của các block. (Một block là một đoạn code nào đó được bao quanh bởi cặp dấu “{“ và “}”.). Không nên đợi đến khi nào cần sử dụng rồi mới khai báo nó; nó có thể gây ra sự rối rắm cho các programmer không cẩn thận khác và giảm tính portable của đoạn code đó. void myMethod() { int int1 = 0; if (condition) { int int2 = 0; ... // phần đầu của method block // phần đầu của "if" block 17 STH VIETNAM } } Có một ngoại lệ đó là chỉ số của các vòng lặp for, đó là ta có thể khai báo nó trong câu lệnh for: String tempString; for (int i = 0; i < maxLoops; i++) { tempString = ...; ... } Các biến cục bộ được sử dụng trong vòng lặp nên được khai báo ở bên ngoài và ngay trước câu lệnh lặp (giống như ví dụ trên). Tránh các khai báo mà nó có thể làm ẩn đi các khai báo đã có ở mức cao hơn. Ví dụ, không nên khai báo một biến cùng tên ở một block phía trong: int count; ... myMethod() { if (condition) { int count = 0; ... } ... } 7.5 // AVOID! Khai báo Class và Interface (Class and Interface Declarations) Khi viết các Java class và interface, cần phải tuân theo những điều sau:  Dấu mở "{" phải được đặt ở cuối dòng.  Dấu đóng "}" phải được đặt ở một dòng mới. class Sample extends Object { int ivar1; int ivar2; Sample(int i, int j) { ivar1 = i; ivar2 = j; } int emptyMethod() { ... } ... }  Các method phải được cách nhau bằng một dòng trống 18 STH VIETNAM 8 CÁC CÂU LỆNH (STATEMENTS) 8.1 Các câu lệnh đơn giản (Simple Statements) Mỗi dòng chỉ nên chứa nhiều nhất là một câu lệnh. Ví dụ: argv++; // Đúng argc--; // Đúng argv++; argc--; // KHÔNG NÊN! 8.2 Các câu lệnh phức (Compound Statements) Các câu lệnh phức là các câu lệnh chứa danh sách các câu lệnh được đặt trong cặp dấu "{ statements }". Xem ví dụ ở các phần sau.   Dấu mở “{” phải được đặt ở cuối dòng đầu tiên của câu lệnh phức; dấu đóng “}” phải được đặt ở đầu dòng và được viết lùi sao cho cùng mức với câu lệnh đầu tiên của câu lệnh phức.  8.3 Các câu lệnh được bao ở phía trong phải được viết lùi vào một mức (so với câu lệnh phức). Các dấu đóng và mở được dùng để bao tất cả các câu lệnh (kể các các câu lệnh đơn) khi nó là một phần của cấu trúc điều khiển, ví dụ như các câu lệnh if-else hay for. Điều này giúp ta khi thêm các câu lệnh vào thì cũng không gây ra các bug chỉ vì quên thêm các dấu dóng và mở. Câu lệnh trả về (Return Statements) Một câu lệnh return không nên sử dụng ngoặc đơn trừ khi nó làm cho giá trị trả về được rõ ràng hơn bằng một cách nào đó. Ví dụ: return; return myDisk.size(); return (size ? size : defaultSize); 8.4 Các câu lệnh if, if-else, if else-if else Các câu lệnh if-else nên theo các định dạng sau: if (condition) { statements; } if (condition) { statements; } else { statements; 19 STH VIETNAM } if (condition) { statements; } else if (condition) { statements; } else { statements; } Chú ý: Câu lệnh if luôn sử dụng cặp dấu {}. Tránh sử dụng kiểu viết như sau – dễ gây ra lỗi khi ta thêm các câu lệnh khác: if (condition) //AVOID! THIS OMITS THE BRACES {}! statement; 8.5 Câu lệnh for Một câu lệnh for nên viết theo định dạng sau: for (initialization; condition; update) { statements; } Một câu lệnh for rỗng (tức là công việc của nó chỉ cần khởi tạo, điều kiện, và câu lệnh update) thì nên viết theo định dạng sau: for (initialization; condition; update); Khi sử dụng toán tử comma trong câu lệnh khởi tạo hoặc update của câu lệnh for, phải chú ý tránh sự phức tạp của việc sử dụng nhiều hơn 3 biến. Nếu thực sự cần thiết thì hãy sử dụng các câu lệnh riêng biệt trước vòng lặp for (với các câu lệnh khởi tạo) hoặc là sau vòng lặp for (với các câu lệnh update). 8.6 Câu lệnh While Một câu lệnh while nên theo định dạng sau: while (condition) { statements; } Một câu lệnh while rỗng nên theo định dạng sau: while (condition); 8.7 Câu lệnh Do-while Một câu lệnh do-while nên theo định dạng sau: do { statements; } while (condition); 20