Đang tải... (xem toàn văn)
mẫu biểu, quy trình ,phát triển, phần mềm
hớng dẫn viết mã ch-ơng trình phần mềmHD.PM.05.02Lần sửa đổi:0Ngày có hiệu lực:Trang: 1 / 8Bảng theo dõi thay đổi tài liệuSTT Vị trí sửa đổi Tóm tắt nội dung thay đổi Ghi chúNgời viết Ngời kiểm tra Phê duyệtHọ tênChữ kýTrang 1 hớng dẫn viết mã ch-ơng trình phần mềmHD.PM.05.02Lần sửa đổi:0Ngày có hiệu lực:Trang: 2 / 8Một số quy định chung:- Cách ghi Số hiệu tài liệu (là tên cột của một số bảng trong BM.PM.05.01) : sẽ đợc điền mã số tài liệu cần tham khảo để biết thêm thông tin chi tiết về đối tợng mô tả . Cách điền mã số tuân theo quy định sau:<Tên biểu mẫu>/xxxxxx : có giá trị từ 001 cho đến 999<tên biểu mẫu> : là mã số biểu mẫu cần tham chiếu tớiVí dụ : BM.PM.05.04/0011. Thiết kế chức năng1.1 Sơ đồ khối chức năngYêu cầu: Khi thiết kế sơ đồ khối chức năng phải bám sát nghiệp vụ bài toán, sao cho khi đọc sơ đồ khối chức năng và phần giải thích bên dới phải hiểu đợc toàn bộ nghiệp vụ của bài toán.Khái niệm chức năng: là phần công việc, thao tác có thể gọi đợc bằng tên trong yêu cầu nghiệp vụ đặt ra.Khái niệm sơ đồ khối: Mô tả toàn bộ nội dung công việc bài toán đặt ra bằng hình khối. Sơ đồ khối thể hiện quan hệ giữa các chức năng.Một số ký hiệu quy ớc trong sơ đồ khối: + Mỗi chức năng đợc biểu diễn trong hình hộp chữ nhật + Mũi tên chỉ thứ tự thực hiện chức năng A trớc sau đó đến chức năng B hoặc chức năng C.+ Chú thích bên trên hoặc bên trái đờng mũi tên. Có thể viết thẳng chú thích bên trên đờng mũi tên hoặc đánh ký mã hiệu và chú giải bên dới. 1.2 Mô tả chi tiết chức năng1.2.1 Mô tả-Có thể sử dụng một vài câu ngắn gọn mô tả tổng thể sơ đồ khối.Trang 221AB CD hớng dẫn viết mã ch-ơng trình phần mềmHD.PM.05.02Lần sửa đổi:0Ngày có hiệu lực:Trang: 3 / 8-Đối với mỗi chức năng phải mô tả chi tiết, ít nhất phải có thông tin về tên chức năng, ý nghĩa, mục đích, nội dung, có thể tuỳ từng chức năng mà có thêm các thông tin khác liên quan.1.2.2 Lựa chọn đờng đi của chức năngSTT Chức năng bắt đầu Chức năng tiếp theoSự kiện Mô tả1 A B Thoả mãn 1 2 A C Thoả mãn 2 3 B D 4 D A 3. Thiết kế các hàm, thủ tục, th viện, hằng,biến dùng chung3.1 Danh sách :Điền toàn bộ tên các hàm, thủ tục, th viện, hằng, biến dùng chung ở mức project Cách điền nội dung vào các cột của bảng Danh sách các hàm, thủ tục, th viện, hằng, biến Bảng : Danh sách các hàm, thủ tục, th viện, hằng, biếnSTT Tên Kiểu Nơi gọi Nơi chứa ý nghĩa/mục đíchSố hiệu tài liệu<Danh sách các hàm><Danh sách các thủ tục><Danh sách các th viện><Danh sách các hằng><Danh sách các biến>Tên: tên hàm, thủ tục, th viện, hằng, biến dùng chungKiểu: nếu là biến hoặc hàm thì phải chỉ ra kiểu của chúng là gì (interger, char, boolean, datetime, .) Nơi gọi: là nơi sử dụng tên này (chẳng hạn form nào, event nào, hàm hoặc thủ tục nào, . gọi tới tên này)Nơi chứa: là nơi lu chứa hàm, thủ tục, hằng, biến chỉ ra . Ví dụ thủ tục A đặt tại module1, hàm B đặt ở module2, th viện C đặt tại th mục ,ổ đĩa nào, . Số hiệu tài liệu: là mã số tài liệu cần tham chiếu tới để xem những thông tin chi tiết về hàm, thủ tục, hằng, biến dùng chung (mã số tài liệu này cũng đợc ghi trong biểu mẫu BM.PM.05.03)3.2 Mô tả chi tiết Cách điền nội dung vào biểu mẫu BM.PM.05.03 nh sau:Số hiệu tài liệu: (trùng với số hiệu tài liệu điền ở bảng Danh sách các hàm, thủ tục, th viện, hằng, biến mục 3.1,BM.PM.05.01)Trang 3 hớng dẫn viết mã ch-ơng trình phần mềmHD.PM.05.02Lần sửa đổi:0Ngày có hiệu lực:Trang: 4 / 8Tên (hàm/thủ tục/th viện/hằng/biến): (có thể điền hoặc không)Cách gọi: chỉ ra cú pháp lời gọi hàm/thủ tục của th viện cần dùng.Trờng hợp hàm, thủ tục dùng chung trong project tự thiết kế thì nội dung này có thể để trống Sơ đồ và mô tả chi tiết thuật toán: vẽ sơ đồ thuật toán đồng thời mô tả thuật toán cho rõ ràng hơn bằng lời Chú ý: Mục 4,5 của BM.PM.05.03 có thể không cần áp dụng đối với các th viện có sẵn, nếu thấy cần thiết phải mô tả kỹ hơn về các th viện thì điền vào mục 6.4. Các tiện ích cần thiết5 4.1 Danh sáchBảng : Danh sách các tiện íchSTT Tên Loại ý nghĩa/mục đích Số hiệu tài liệu4.2 Mô tả cách sử dụng : (điền nội dung vào BM.PM.05.04)Cách điền nội dung vào biểu mẫu BM.PM.05.04 nh sau:Số hiệu tài liệu: (trùng với số hiệu tài liệu điền ở bảng Danh sách các tiện ích mục 4.1,BM.PM.05.01) Tên tiện ích : (có thể điền hoặc không) Mô tả cách sử dụng: mô tả bằng lời một cách rõ ràng để ngời lập trình hiểu đợc cách sử dụng các tiện ích này (chẳng hạn, cách cài đặt chúng nh thế nào, đặt ở ổ đĩa và th mục nào, cách gọi chúng ra sao,vv 5. Thiết kế giao diện5.1 Yêu cầu chung đối với giao diệnNếu thấy cần thiết phải có yêu cầu chung đối với giao diện thì đa ra, nếu không thấy cần thiết thì phần này có thể bỏ trống. Chẳng hạn có thể nêu ra một số yêu cầu nh:- Ngôn ngữ sử dụng- Chơng trình sử dụng là online hay offline, có thờng trú hay không thờng trú- Có cần hiện lên task bar không- Màu sắc sử dụng để thiết kế form (tuỳ tính chất của ứng dụng để thiết kế màu sắc, giao diện. Ví dụ, làm chơng trình cho đối tợng học sinh sử dụng màu sắc, trang trí phải vui tơi)Trang 4 hớng dẫn viết mã ch-ơng trình phần mềmHD.PM.05.02Lần sửa đổi:0Ngày có hiệu lực:Trang: 5 / 8- Có cần tạo sẵn các template cho các form không. Ví dụ một số chơng trình thống nhất chung template cho các form danh mục, template cho form nhập dữ liệu5.2 Cấu trúc giao diện (hình vẽ)Trên đây là một ví dụ về cấu trúc giao diện một phần trong chơng trình station của dự án 119.+ Mỗi form biểu diễn bằng một ô chữ nhật, bên trong ghi tên form+ Mũi tên theo chiều hớng gọi từ form này tới form kia. Trên đờng mũi tên là ký mã hiệu sẽ đợc giải thích trong phần sau.- Liệt kê các form trong chơng trìnhSTT Tên form Chức năng của form Chức năng nghiệp vụ liên quanSố hiệu tài liệu1 start Kiểm tra quyền truy nhập vào hệ thống2 passchangeDlg Đổi password của ngời sử dụng3 main Chức năng chính nhập báo hỏng, thông qua form này gọi đến các chức năng tra cứu, trợ giúp, tra nợ, đo thử4 Nội dung của cột Chức năng nghiệp vụ liên quan:là tên các chức năng tơng ứng đợc nêu trong mục 1.Thiêt kế chức năng của BM.PM.05.01) Nội dung của cột Số hiệu tài liệu: chính là số hiệu tài liệu ghi trong biểu mẫu BM.PM.05.02 mà ngời lập trình cần tham chiếu tới để xem mô tả chi tiết về form - Mô tả đờng đi của formSTT Mã hiệu đờng điForm gọiForm đợc gọi Sự kiện Mô tả1 1 start passchangeDlgKích vào nút đổi mật khẩuKhi nhập đúng tên và password ngời sử dụng nút gọi đến Trang 554321startpasschangeDlg mainlookup loan hớng dẫn viết mã ch-ơng trình phần mềmHD.PM.05.02Lần sửa đổi:0Ngày có hiệu lực:Trang: 6 / 8form đổi mật khẩu mới enabled2 2 start main Kích vào nút bắt đầuKhi nhập đúng tên và password ngời sử dụng nút gọi đến form main mới enabled3 . . 5.3 Mô tả chi tiết formPhần này bao gồm cả hình vẽ và nội dung mô tả5.3.1 Vẽ hìnhPhần này có thể trình bày sơ lợc hoặc chi tiết tuỳ ngời thiết kế(có thể in ra hoặc vẽ bằng tay). Ví dụ: form start trong chơng trình 1195.3.2 Mô tả chi tiết:Nội dung phần mô tả chi tiết đợc điền vào BM.PM.05.02, bao gồm các nội dung sau: Số hiệu tài liệu: điền vào số hiệu để bảng Danh sách các form có thể tham chiếu tới Tên form: trùng với tên đợc liệt kê trong bảng Danh sách các form (có thể không điền cũng đợc) Bảng mô tả các đối tợng thuộc form:Ví dụ cho form startSTT Tên object Loại ý nghĩa/mục đích Thuộc objectTrang 6 hớng dẫn viết mã ch-ơng trình phần mềmHD.PM.05.02Lần sửa đổi:0Ngày có hiệu lực:Trang: 7 / 81 Label1 Label2 Label23 Label34 user text Nhập tên ngời truy nhập5678 Issuechangepasscommand Gọi đến form có chức năng đổi mật khẩu9 . Mô tả chi tiết : Mô tả các hành động, tình huống xảy ra trong phạm vi form tơng ứng với một giá trị nhập mới vào một đối tợng nào đó hoặc khi chọn đối tợng nào đó Ví dụ form start:- Ban đầu hai nút lệnh đổi mật khẩu và nút lệnh gọi đến form main không enabled. Nhập đầy đủ tên, password thì hai nút lệnh đổi mật khẩu và nút lệnh gọi đến form main sẽ enabled.- Miêu tả cách sử dụng 2 object ADOconnection truy cập vào CSDL lấy dữ liệu nh thế nào. Trong quá trình truy cập gặp lỗi sẽ bắt lỗi nh thế nào.- .6. Thiết kế các reports6.1 Danh sách các reports:Cách điền vào bảng thông qua ví dụ sau:Bảng : Danh sách reportsSTT Tên ý nghĩa/mục đích Công cụ tạo reportNơi gọi reportSố hiệu tài liệu1 report1 danh sách truy nhập internet trong tháng datareport form1 BM.PM.05.05/0012 report2 danh sách huỷ account internet trong thángcrystal reportsform2 BM.PM.05.05/0026.2 Mô tả chi tiết : (Điền nội dung vào biểu mẫu BM.PM.05.05) Số hiệu tài liệu: chính là số hiệu đợc ghi trong bảng Danh sách các reportsMẫu report: vẽ tay hoặc in ra giấy khuôn mẫu reportBảng mô tả chi tiết:Trang 7 hớng dẫn viết mã ch-ơng trình phần mềmHD.PM.05.02Lần sửa đổi:0Ngày có hiệu lực:Trang: 8 / 8Cách điền nội dung thông qua ví dụ sauSTT Tên đối t-ợngLoại đối t-ợngVị trí đặt đối tợngĐịnh dạng dữ liệuý nghĩa/mục đíchNguồn dữ liệu1 label1 label left corner of header,line 1theo mẫu dd/mm/yyhiển thị date hiện tại2 txt1 textboxcột số máy của reportdồn dữ liệu về mép phải của textboxhiện số máy điện thoại thuê bao-DB:min-Table: SM-Field: so_may36. Kế hoạch đánh giá và chạy thửCách điền vào bảng thông qua ví dụ sau:Bảng : Kế hoạch đánh giá và chạy thử phần lập trìnhSTT Nội dung Ngời thực hiện Thời gian thực hiệnPhơng thức thực hiện/Số hiệu T.L<Kiểm tra chức năng>1 Quản lý user2 Quản lý dữ liệu hệ thống<Kiểm tra database>1 Cấu trúc chung DB có hợp lý không2 Cấu trúc từng bảng3 Các ràng buộc và các trigger<Kiểm tra giao diện><Kiểm tra reports> . . (ở cột Phơng thức/số hiệu T.L nếu phơng thức thực hiện phải mô tả quá dài thì chuyển sang điền vào BM.PM.05.06)Trang 8 . quy định sau:<Tên biểu mẫu& gt;/xxxxxx : có giá trị từ 001 cho đến 999<tên biểu mẫu& gt; : là mã số biểu mẫu cần tham chiếu tớiVí dụ : BM.PM.05. 04/ 0011.. diện. Ví dụ, làm chơng trình cho đối tợng học sinh sử dụng màu sắc, trang trí phải vui tơi)Trang 4 hớng dẫn viết mã ch-ơng trình phần mềmHD.PM.05.02Lần sửa