WikiHow này hướng dẫn bạn cách tạo tài liệu mã giả cho chương trình máy tính của bạn. Về cơ bản, mã giả đòi hỏi phải tạo ra một phác thảo không phải ngôn ngữ lập trình cho mục đích mã của bạn.
Các bước
Phần 1/3: Tìm hiểu kiến thức cơ bản về mã giả
Bước 1. Biết mã giả là gì
Mã giả là một phác thảo từng bước được viết ra của mã của bạn mà bạn có thể chuyển dần sang ngôn ngữ lập trình. Nhiều lập trình viên sử dụng nó để vạch ra chức năng của một thuật toán trước khi tự đặt mình vào nhiệm vụ kỹ thuật hơn là viết mã.
Mã giả đóng vai trò như một hướng dẫn không chính thức, một công cụ để suy nghĩ thông qua các vấn đề của chương trình và một tùy chọn giao tiếp có thể giúp bạn giải thích ý tưởng của mình cho người khác.
Bước 2. Hiểu tại sao mã giả lại hữu ích
Mã giả được sử dụng để chỉ ra cách thức hoạt động của một thuật toán tính toán. Người viết mã thường sử dụng mã giả như một bước trung gian trong lập trình giữa giai đoạn lập kế hoạch ban đầu và giai đoạn viết mã thực thi thực tế. Một số cách sử dụng mã giả khác bao gồm:
- Mô tả cách thức hoạt động của một thuật toán. Mã giả có thể minh họa nơi một cấu trúc, cơ chế hoặc kỹ thuật cụ thể có thể hoặc phải xuất hiện trong một chương trình.
- Giải thích quy trình tính toán cho người dùng ít kỹ thuật hơn. Máy tính cần một cú pháp đầu vào rất nghiêm ngặt để chạy một chương trình, nhưng con người (đặc biệt là những người không phải lập trình viên) có thể thấy dễ dàng hơn khi hiểu một ngôn ngữ chủ quan, linh hoạt hơn nêu rõ mục đích của từng dòng mã.
- Thiết kế mã trong một thiết lập nhóm. Các kiến trúc sư phần mềm cấp cao thường bao gồm mã giả vào thiết kế của họ để giúp giải quyết một vấn đề phức tạp mà họ thấy các lập trình viên của họ đang gặp phải. Nếu bạn đang phát triển một chương trình cùng với các lập trình viên khác, bạn có thể thấy rằng mã giả giúp làm rõ ý định của bạn.
Bước 3. Hãy nhớ rằng mã giả là chủ quan và không chuẩn
Không có cú pháp thiết lập nào mà bạn nhất thiết phải sử dụng cho mã giả, nhưng việc sử dụng các cấu trúc mã giả chuẩn mà các lập trình viên khác có thể dễ dàng hiểu được là một phép lịch sự chuyên nghiệp thông thường. Nếu bạn đang tự viết mã một dự án, thì điều quan trọng nhất là mã giả sẽ giúp bạn cấu trúc suy nghĩ và thực hiện kế hoạch của mình.
- Nếu bạn đang làm việc với những người khác trong một dự án - cho dù họ là đồng nghiệp của bạn, lập trình viên cấp dưới hay cộng tác viên không chuyên về kỹ thuật - thì điều quan trọng là phải sử dụng ít nhất một số cấu trúc tiêu chuẩn để mọi người khác có thể dễ dàng hiểu ý định của bạn.
- Nếu bạn đăng ký một khóa học lập trình tại một trường đại học, trại viết mã hoặc một công ty, bạn có thể sẽ được kiểm tra theo "tiêu chuẩn" mã giả được dạy. Tiêu chuẩn này thường khác nhau giữa các cơ sở và giáo viên.
Sự rõ ràng là mục tiêu chính của mã giả và nó có thể hữu ích nếu bạn làm việc trong các quy ước lập trình được chấp nhận. Khi bạn phát triển mã giả của mình thành mã thực, bạn sẽ cần phải phiên mã nó sang một ngôn ngữ lập trình - vì vậy nó có thể giúp cấu trúc dàn bài của bạn với điều này.
Bước 4. Tập trung vào mục đích chính của mã giả
Có thể dễ dàng trở lại viết mã sau khi bạn đạt được bước tiến của mình. Ghi nhớ mục đích của mã giả là giải thích những gì mỗi dòng của chương trình phải làm - sẽ giúp bạn có cơ sở khi tạo tài liệu mã giả.
Phần 2/3: Viết mã giả tốt
Bước 1. Sử dụng trình soạn thảo văn bản thuần túy
Bạn có thể bị hấp dẫn khi sử dụng trình xử lý văn bản (ví dụ: Microsoft Word) hoặc một chương trình tương tự để tạo tài liệu văn bản đa dạng thức, nhưng mã giả cần ít định dạng nhất có thể để giữ cho nó đơn giản.
Các trình soạn thảo văn bản thuần túy bao gồm Notepad (Windows) và TextEdit (Mac).
Bước 2. Bắt đầu bằng cách viết ra mục đích của quá trình
Dành một hoặc hai dòng để giải thích mục đích của mã của bạn sẽ giúp thiết lập phần còn lại của tài liệu và nó cũng sẽ giúp bạn tiết kiệm nhiệm vụ giải thích chức năng của chương trình cho từng người mà bạn hiển thị mã giả.
Bước 3. Chỉ viết một câu lệnh trên mỗi dòng
Mỗi câu lệnh trong mã giả của bạn chỉ nên thể hiện một hành động cho máy tính. Trong hầu hết các trường hợp, nếu danh sách nhiệm vụ được vẽ đúng cách, thì mỗi nhiệm vụ sẽ tương ứng với một dòng mã giả. Cân nhắc viết ra danh sách nhiệm vụ của bạn, sau đó dịch danh sách đó thành mã giả, sau đó dần dần phát triển mã giả đó thành mã thực tế, máy tính có thể đọc được.
Bước 4. Sử dụng khoảng trắng và thụt lề một cách hiệu quả
Sử dụng khoảng trắng giữa các "khối" văn bản sẽ giúp giữ các thành phần khác nhau của mã giả của bạn bị cô lập và việc thụt lề các phần khác nhau của mỗi khối sẽ cho biết rằng các đoạn mã giả đó nằm dưới một phần ít được thụt lề hơn.
Ví dụ: một phần của mã giả thảo luận về việc nhập một số tất cả phải nằm trong cùng một "khối", trong khi phần tiếp theo (ví dụ: phần thảo luận về đầu ra) phải nằm trong một khối khác
Bước 5. Viết hoa các lệnh chính nếu cần
Tùy thuộc vào yêu cầu mã giả của bạn hoặc môi trường mà bạn đang xuất bản mã giả, bạn có thể cần viết hoa các lệnh sẽ vẫn còn trong mã thực.
Ví dụ: nếu bạn sử dụng lệnh "if" và "then" trong mã giả của mình, bạn có thể muốn thay đổi chúng để đọc "IF" và "THEN" (ví dụ: "Số đầu vào IF THEN kết quả đầu ra")
Bước 6. Viết bằng thuật ngữ đơn giản
Hãy nhớ rằng, bạn đang viết về những gì dự án sẽ thực hiện, không phải tóm tắt chính mã. Điều này đặc biệt quan trọng nếu bạn đang viết mã giả để phục vụ như một minh chứng cho khách hàng không biết viết mã hoặc như một dự án cho một lập trình viên mới bắt đầu.
Bạn thậm chí có thể muốn loại bỏ hoàn toàn bất kỳ lệnh mã hóa nào và chỉ cần xác định quy trình của mỗi dòng bằng ngôn ngữ đơn giản. Ví dụ: "nếu đầu vào là số lẻ, đầu ra 'Y'" có thể trở thành "nếu người dùng nhập số lẻ, thay vào đó hãy hiển thị 'Y'".
Bước 7. Giữ mã giả của bạn theo thứ tự thích hợp
Mặc dù ngôn ngữ bạn sử dụng để sửa đổi mã giả của mình phải đơn giản, nhưng bạn vẫn cần giữ từng phần của mã giả theo thứ tự mà nó cần được thực thi.
Bước 8. Không để lại gì cho trí tưởng tượng
Tất cả mọi thứ đang xảy ra trong quá trình phải được mô tả hoàn chỉnh. Các câu lệnh giả gần giống với các câu lệnh tiếng Anh đơn giản. Mã giả thường không sử dụng các biến, mà thay vào đó mô tả những gì chương trình phải làm với các đối tượng gần với thế giới thực như số tài khoản, tên hoặc số tiền giao dịch.
Bước 9. Sử dụng các cấu trúc lập trình tiêu chuẩn
Ngay cả khi không có tiêu chuẩn cho mã giả, các lập trình viên khác sẽ dễ dàng hiểu các bước của bạn hơn nếu bạn sử dụng cấu trúc từ các ngôn ngữ lập trình (tuần tự) hiện có. Sử dụng các thuật ngữ như "if", "then", "while", "else" và "loop" giống như cách bạn làm trong ngôn ngữ lập trình ưa thích của mình. Hãy xem xét các cấu trúc sau:
- nếu ĐIỀU KIỆN thì HƯỚNG DẪN - Điều này có nghĩa là một lệnh nhất định sẽ chỉ được thực hiện nếu một điều kiện nhất định là đúng. "Hướng dẫn", trong trường hợp này, có nghĩa là một bước mà chương trình sẽ thực hiện, trong khi "điều kiện" có nghĩa là dữ liệu phải đáp ứng một bộ tiêu chí nhất định trước khi chương trình thực hiện.
- while CONDITION do HƯỚNG DẪN - Điều này có nghĩa là lệnh phải được lặp đi lặp lại cho đến khi điều kiện không còn đúng nữa.
- do HƯỚNG DẪN TRONG KHI ĐIỀU KIỆN - Điều này rất giống với "trong khi ĐIỀU KIỆN do HƯỚNG DẪN". Trong trường hợp đầu tiên, điều kiện được kiểm tra trước khi hướng dẫn được thực hiện, nhưng trong trường hợp thứ hai, hướng dẫn sẽ được thực hiện trước; do đó, trong trường hợp thứ hai, HƯỚNG DẪN sẽ được tiến hành ít nhất một lần.
- function NAME (ARGUMENTS): HƯỚNG DẪN - Điều này có nghĩa là mỗi khi một tên nào đó được sử dụng trong mã, nó là chữ viết tắt của một lệnh nhất định. "Đối số" là danh sách các biến mà bạn có thể sử dụng để làm rõ hướng dẫn.
Bước 10. Sắp xếp các phần mã giả của bạn
Nếu bạn có nhiều phần mã giả xác định các phần mã giả khác trong cùng một khối, bạn có thể muốn sử dụng dấu ngoặc hoặc các số nhận dạng khác để giữ mọi thứ được chứa.
- Dấu ngoặc vuông - cả chuẩn (ví dụ: [code]) và cong (ví dụ: {code}) - có thể giúp chứa các đoạn mã giả dài.
-
Khi viết mã, bạn có thể thêm nhận xét bằng cách nhập "" ở phía bên trái của nhận xét (ví dụ:
// Đây là bước tạm thời.
- ). Bạn có thể sử dụng phương pháp tương tự khi viết mã giả để để lại các ghi chú không phù hợp với văn bản mã hóa.
Bước 11. Kiểm tra kỹ mã giả của bạn để dễ đọc và rõ ràng
Bạn sẽ có thể trả lời các câu hỏi sau vào cuối tài liệu:
- Một người không quen thuộc với quy trình này có hiểu được mã giả này không?
- Mã giả có được viết theo cách dễ dàng để dịch nó sang ngôn ngữ máy tính không?
- Mã giả có mô tả toàn bộ quá trình mà không bỏ sót gì không?
- Mọi tên đối tượng được sử dụng trong mã giả có được đối tượng mục tiêu hiểu rõ ràng không?
- Nếu bạn thấy rằng một phần của mã giả cần được xây dựng kỹ lưỡng hoặc nó không phác thảo rõ ràng một bước mà người khác có thể quên, hãy quay lại và thêm thông tin cần thiết.
Phần 3/3: Tạo tài liệu mã giả mẫu
Bước 1. Mở trình soạn thảo văn bản thuần túy
Bạn có thể sử dụng Notepad (Windows) hoặc TextEdit (Mac) theo mặc định nếu không muốn cài đặt chương trình mới.
Bước 2. Xác định chương trình của bạn
Mặc dù không hoàn toàn cần thiết, việc viết một dòng một hoặc hai câu ở đầu tài liệu sẽ làm rõ ý định của chương trình ngay từ đầu:
Chương trình này sẽ yêu cầu một lời chào từ người dùng. Nếu lời chào phù hợp với một câu trả lời cụ thể, câu trả lời sẽ được gửi đi; nếu không, một lời từ chối sẽ được gửi đến.
Bước 3. Viết trình tự mở đầu
Lệnh đầu tiên của bạn - đó là, điều đầu tiên chương trình của bạn phải làm khi chạy - phải là dòng đầu tiên:
in lời chào "Xin chào người lạ!"
Bước 4. Thêm dòng tiếp theo
Đặt một khoảng trống giữa dòng cuối cùng và dòng tiếp theo bằng cách nhấn ↵ Enter, sau đó tạo dòng mã tiếp theo. Trong ví dụ này, người dùng nên nhắc dòng đối thoại tiếp theo:
in nhắc nhấn "Enter" để tiếp tục
Bước 5. Thêm lời kêu gọi hành động
Trong ví dụ này, người dùng sẽ được nhắc về một lời chào:
in lời gọi hành động "Bạn có khỏe không?"
Bước 6. Hiển thị cho người dùng danh sách các câu trả lời
Một lần nữa, sau khi nhấn ↵ Enter trong ví dụ này, người dùng sẽ thấy danh sách các phản hồi có thể có:
hiển thị các câu trả lời có thể có "1. Tốt." "2. Tuyệt vời!" "3. Không tốt."
Bước 7. Yêu cầu đầu vào từ người dùng
Đây là nơi chương trình sẽ yêu cầu người dùng nhập một phản hồi:
yêu cầu in cho đầu vào "Nhập số mô tả tốt nhất về bạn:"
Bước 8. Tạo lệnh "if" cho đầu vào của người dùng
Vì có nhiều câu trả lời mà người dùng có thể chọn, bạn sẽ muốn thêm nhiều kết quả dựa trên câu trả lời đã chọn của họ:
nếu "1" in phản hồi "Dandy!" nếu "2" in phản hồi "Tuyệt vời!" nếu phản hồi in "3" "Sáng lên, buttercup!"
Bước 9. Thêm thông báo lỗi
Trong trường hợp người dùng chọn phản hồi không chính xác, bạn có thể có sẵn thông báo lỗi:
nếu đầu vào không được nhận dạng thì phản hồi in "Bạn làm theo hướng dẫn không tốt phải không?"
Bước 10. Thêm bất kỳ thành phần nào khác của chương trình
Xem qua tài liệu của bạn và thêm hoặc cắt bỏ bất kỳ chi tiết nào để đảm bảo rằng cả bạn và bất kỳ ai đọc tài liệu đều hiểu được ý nghĩa của nó. Theo ví dụ của phương pháp này, tài liệu mã giả cuối cùng của bạn sẽ trông giống như sau:
Chương trình này sẽ yêu cầu một lời chào từ người dùng. Nếu lời chào phù hợp với một câu trả lời cụ thể, câu trả lời sẽ được gửi đi; nếu không, một lời từ chối sẽ được gửi đến. in lời chào "Xin chào người lạ!" in nhắc nhấn "Enter" để tiếp tục
in lời gọi hành động "Hôm nay bạn thế nào?" hiển thị các câu trả lời có thể có "1. Tốt." "2. Tuyệt vời!" "3. Không tốt." yêu cầu in cho đầu vào "Nhập số mô tả chính xác nhất về bạn:" if "1" in phản hồi "Dandy!" nếu "2" in phản hồi "Tuyệt vời!" nếu "3" in phản hồi "Sáng lên, mao!" nếu đầu vào không được nhận dạng thì phản hồi in "Bạn làm theo hướng dẫn không tốt phải không?"
Bước 11. Lưu tài liệu của bạn
Nhấn Ctrl + S (Windows) hoặc ⌘ Command + S (Mac), nhập tên và nhấp Cứu làm như vậy.
Video - Bằng cách sử dụng dịch vụ này, một số thông tin có thể được chia sẻ với YouTube
