I. Mục tiêu của tài liệu này:
Bạn đang học lập trình, vậy bạn nghĩ về một chương trình máy tính như thế nào?
Một chương trình máy tính có thể xem như một tác phẩm (như bài báo, một câu truyện, một cuốn tiểu thuyết, …) bởi vì nó được đọc bởi bạn (có thể bây giờ, mà cũng có thể là 10 năm sau!), và bởi những lập trình viên khác sau bạn (để phát triển, sửa chửa, cập nhật, …). Chính vì lẽ đó, một chương trình máy tính nên đáp ứng cả 3 yêu cầu sau: đúng, dễ đọc và dễ hiểu.
Mục tiêu của tài liệu này là cung cấp cho bạn:
1. Một tập hợp các chuẩn trình bày chương trình thông dụng.
2. Một thói quen để từ đó bạn có một phong cách lập trình tương đối chuyên nghiệp.
Tuy nhiên, tài liệu này không có tham vọng đề cập đến toàn bộ các khía cạnh của một phong cách lập trình. Nó chỉ nói đến những gì cần thiết để cho bạn, một sinh viên, khi chưa tìm được một phong cách phù hợp tạo được những thói quen tốt ngay từ đầu.
II. Một số nguyên tắc cần tuân thủ khi lập trình:
A. Trình bày tổng thể chương trình:
1. Môđun hóa chương trình của bạn
Chương trình của bạn nên được tách thành nhiều môđun, mỗi môđun thực hiện một công việc và càng độc lập với nhau càng tốt. Điều này sẽ giúp bạn dễ bảo dưỡng chương trình hơn và khi đọc chương trình, bạn không phải đọc nhiều, nhớ nhiều các đoạn lệnh nằm rải rác để hiểu được điều gì đang được thực hiện.
Khi muốn chuyển thông tin cho các chương trình con, bạn nên sử dụng các tham số. Tránh sử dụng các biến toàn cục để chuyển thông tin giữa các chương trình con. làm như vậy bạn sẽ triệt tiêu tính độc lập giữa các chương trình con và rất khó khăn khi kiểm soát giá trị của chúng khi chương trình thi hành. (Chú ý, bạn nên phân biệt giữa biến toàn cục và hằng số toàn cục)
2. Cách trình bày chương trình nên nhất quán
Chương trình của bạn càng nhất quán, thì nó sẽ càng dễ đọc và dễ hiểu. Hơn nữa, bạn sẽ càng mất ít thời gian nghĩ về cách viết chương trình, và như vậy bạn sẽ có nhiều thời gian hơn để nghĩ về các vấn đề cần giải quyết.
3. Chương trình nên giữ được tính đơn giản và rõ ràng trong hầu hết các tình huống.
Việc sử dụng các mẹo lập trình chỉ thể hiện sự khéo léo của lập trinh viên và làm tăng hiệu quả chương trình lên một chút, trong khi điều đó sẽ đánh mất đi tính đơn giản và rõ ràng của chương trình.
Ví dụ:
a[i++] = 1;
nên được viết là:
a[i] = 1;
i++;
Hoặc:
if (doSomeThing() == false) …
nên được viết là:
bool result = doSomeThing();
if (result == false) …
4. Mã lệnh mà bạn viết phải thể hiện đúng cấu trúc chương trình của bạn.
Ví dụ:
Dòng lệnh:
if (count == 0) printf(``No data.\n'');
nên được viết là:
if (count == 0)
printf(``No data.\n'');
Và như vậy, theo bạn, dòng lệnh sau có thể hiện đúng cấu trúc chương trình không?
if (count != 0)
printf(``%d\n'', count);
average = total/count;
5. Chương trình của bạn nên thực hiện như một dòng chảy từ trên xuống dưới, không nên có những thay đổi bất chợt. Để có được điều này, bạn không nên sử dụng goto hay continue.
B. Khai báo biến và hàm
1. Một câu lệnh nên được đặt riêng trên một dòng, điều này sẽ giúp bạn rất nhiều trong quá trình debug.
Ví dụ:
Nếu bạn viết:
while (i < 100) i++;
bạn sẽ không biết được vòng lặp trên được thực hiện bao nhiêu lần khi debug..
Cũng tương tự:
if (i < 100) i++;
bạn sẽ không biết được lệnh if có được thực hiện hay không trong quá trình debug (trừ khi bạn phải theo dõi giá trị của i).
2. Các dấu {} bao các khối lệnh phải được canh thẳng hàng.
Có 2 cách thường được chấp nhận để canh thẳng các dấu {}:
a. Cách 1:
if (...)
{
.
.
.
}
else
{
.
.
.
}
while (...)
{
.
.
.
}
b. Cách 2:
if (...) {
.
.
.
}
else {
.
.
.
}
while (...) {
.
.
.
}
Và như vậy, khi viết các khối lệnh nằm trong một cặp ngoặc {}, bạn nên viết cặp ngoặc trước rồi mới viết các lệnh vào giữa, làm như vậy bạn sẽ tránh trường hợp thiếu các dấu ngoặc này.
3. Biến nên được khai báo ở gần vị trí mà nó bắt đầu được sử dụng, như vậy bạn sẽ tránh được việc khai báo một loạt các biến dư thừa ở đầu hàm hay chương trình.
4. Mỗi biến nên khai báo trên một hàng nhằm dễ chú thích về ý nghĩa của mỗi biến.
Ví dụ:
int level = 0; // indentation level
int size = 0; // size of symbol table
int lines = 0; // lines read from input
5. Tên biến nên đặt sao cho đủ nghĩa, có thể là là các từ hoàn chỉnh hoặc viết tắt nhưng phải dễ đọc (dễ phát âm).
Ví dụ:
wages = hoursWorked * hourlyRate;
rõ ràng hơn là
w = h * r;
Ngoại lệ: Các biến sử dụng để chạy các vòng lặp nên đặt đơn giản là: i, j, k, …
6. Tên của một hàm nên phản ánh công việc hoặc giá trị trả về của nó.
Ví dụ:
CheckForErrors() thay vì ErrorCheck()
DumpDataToFile() thay vì DataFile().
7. Bạn nên sử dụng hợp lý các ký tự hoa và thường khi đặt tên biến, điều này sẽ giúp chương trình dễ đọc hơn, một số gợi ý như sau:
• Tên biến được viết bằng chữ thường, viết hoa chữ các đầu tiên của từ thứ hai trong tên biến (kiểu camelBack), ví dụ: totalHouseWorked.
• Tên hằng số được viết hoa toàn bộ, các từ viết cách nhau bằng dấu gạch dưới, ví dụ: TAX_RATE.
• Các kiểu dữ liệu do người dùng định nghĩa được viết hoa toàn bộ hoặc viết hoa các ký tự đầu, ví dụ: BIGINT hay BigInt.
• Tên các hàm được viết hoa chữ cái đầu từ, có thể bắt đầu từ từ thứ nhất hay thứ hai, ví dụ: DisplayInfo() hoặc displayInfo().
8. Các hằng số không nên viết trực tiếp vào chương trình.
Thay vì thế, người ta thường sử dụng lệnh #define hay const để đặt cho những hằng số này những tên có ý nghĩa. Điều này sẽ giúp lập trình viên dễ kiểm soát những chương trình lớn vì giá trị của hằng số khi cần thay đổi thì chỉ phải thay đổi một lần duy nhất ở giá trị định nghĩa (ở #define hay const).
Ví dụ:
popChange = (0.1758 - 0.1257) * population;
nên được viết là:
const double BIRTH_RATE = 0.1758,
DEATH_RATE = 0.1257;
...
popChange = (BIRTHRATE - DEATH_RATE) * population;
Ghi chú: bạn không nên dùng #define thường xuyên để định nghĩa các hằng số, bởi vì trong quá trình debug, bạn sẽ không thể xem được giá trị của một hằng số định nghĩa bằng #define.
9. Khi khai báo con trỏ, dấu con trỏ nên được đặt liền với tên, nhằm tránh trường hợp sau:
char* p, q, r; // ß q, r không là con trỏ
Trong trường hợp này nên viết là:
char *p, *q, *r;
(luật này cũng được dùng khi khai báo tham chiếu với dấu &)
C. Trình bày dòng lệnh:
1. Các biến không nên được sử dụng lại với nhiều nghĩa khác nhau trong cùng một hàm.
Ví dụ:
Không nên sử dụng biến như sau:
for (i = 0; i < n; i++) // ß n mang ý nghĩa là số lần lặp
. . .
for (i = 0; i < 10; i++)
for (n = 0; n < 10; n++) //ß n sử dụng như biến điều khiển lặp
. . .
2. Các toán tử và toán hạng trong một biểu thức nên được tách rời nhau nhằm làm biểu thức dễ đọc hơn.
Ví dụ:
mass = volume * density;
Thay vì:
mass=volume*density;
Ngoại lệ: không chèn khoảng trắng vào giữa toán hạng và toán tử ++ và –
3. Nên có khoảng trắng ngăn cách giữa dấu phẩy hay chấm phẩy với các tham số.
4. Nên có khoảng trắng giữa từ khóa và dấu ‘(’, nhưng không nên có khoảng trắng giữa tên hàm và dấu ‘(‘.
Ví dụ:
// no space between 'strcmp' and '(',
// but space between 'if' and '('
if (strcmp(input_value, "done") == 0)
return 0;
5. Nên sử dụng các dấu ( ) khi muốn tránh các lỗi về độ ưu tiên toán tử.
Ví dụ:
// No!
int i = a >= b && c < d && e <= g + h;
// Better
int j = (a >= b) && (c < d) && (e <= (g + h));
6. Nên dùng các dòng trắng để phân chia các hàm trong một tập tin, các đoạn lệnh trong một hàm như: đoạn nhập xuất dữ liệu, các đoạn tương ứng với các bước xử lý khác nhau,
7. Mỗi dòng lệnh không nên dài quá 80 ký tự, điều này giúp việc đọc chương trình dễ dàng hơn khi không phải thực hiện các thao tác cuộn ngang mang hình.
8. Một dòng lệnh quá dài nên được tách thành nhiều dòng.
Ví dụ:
if (foo->next == NULL
&& totalcount < needed && needed <= MAX_ALLOT
&& server_active(current_input))
{
...
}
Hoặc:
for (curr = *listp, trail = listp;
curr != NULL;
trail = &(curr->next), curr = curr->next)
{
...
}
Hoặc:
int myComplexFunction( unsigned unsignedValue,
int intValue,
char *charPointerValue,
int *intPointerValue,
unsigned *unsignedPointerValue);
D. Chú thích chương trình:
1. Khi đặt các chú thích, bạn nên sử dụng dấu // vì dấu này sẽ không có ảnh hưởng khi bạn sử dụng cặp ký hiệu /* */ để vô hiệu hóa một đoạn lệnh trong quá trình sửa lỗi chương trình. Bạn nên nhớ rằng trong C/C++ không cho phép các cặp dấu /* */ lồng nhau.
2. Với các chú thích ngắn, bạn đặt nó trên cùng dòng lệnh cần chú thích. Với các chú thích dài hơn, hoặc chú thích cho cả một đoạn lệnh, bạn đặt câu chú thích trên một dòng riêng ngay phía trên câu lệnh cần chú thích.
Ví dụ:
Chú thích ngắn:
if (a == 2)
return(TRUE); // special case
else
return(isprime(a)); // works only for odd a
...
Chú thích dài:
if (argc > 1) {
// Get input file from command line.
if (freopen(argv[1], "r", stdin) == NULL)
error("can't open %s\n", argv[1]);
}
3. Không nên lạm dụng chú thích.
Ví dụ:
i++; // tăng i lên 1 đơn vị
Chú thích như trên là không cần thiết vì bản thân dòng lệnh đã nói lên mục tiêu của nó. Thay vì vậy, bạn nên cố gắng giữ cho chương trình của bạn dễ đọc, dễ hiểu qua việc trình bày chương trình rõ ràng, đơn giản và cách đặt tên hợp lý.
II. Ví dụ:
Code:
/***********************************************
* Program : Equation solving
* Written by : Nguyen Tan Dat
* Email : ntdat@fit.hcmuns.edu.vn
* Last update : 10/3/2002
************************************************/
#include
#include
#define NO_SOL 1 //no solution
#define ONE_SOL 2 //one solution
#define MULTI_SOL 3 //undefined solution
// Function name : Input
// Description : get coefficients
// Return type : void
// Argument : int *a
// Argument : int *b
void Input(int *a, int *b)
{
printf("a = ");
scanf("%d", a);
printf("b = ");
scanf("%d", b);
}
// Function name : Output
// Description : print result
// Return type : void
// Argument : int nSol -- solution type
// Argument : float x -- the solution
void Output(int nSol, float x = 0)
{
switch (nSol)
{
case NO_SOL:
printf("No solution!\n");
break;
case ONE_SOL:
printf("One solution: %f\n", x);
break;
case MULTI_SOL:
printf("Undefined solution!\n");
break;
}
}
void main()
{
int a, b; // coefficients
int nSol; // solution type
float x; // the solution
Input(&a, &b);
if (a == 0)
{
if (b == 0)
nSol = MULTI_SOL;
else
nSol = NO_SOL;
}
else
{
nSol = ONE_SOL;
x = -(float)b/a;
}
Output(nSol, x);
getch();
}
Bài viết được trích từ diễn đàn toán tin ĐHKHTN TPHCM toantin.org
